Revision 53334
Added by Alessia Bardi over 5 years ago
modules/dnet-api-http-doc/src/svnlog.info | ||
---|---|---|
1 |
To generate an updated changelist of this documentation as html page run the following command: |
|
2 |
|
|
3 |
> cd dnet-api-http-doc/src |
|
4 |
> svn log -v --xml https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc | xsltproc svnlog2html.xslt - > ./changelog.html |
modules/dnet-api-http-doc/src/README_BEFORE_COMMITTING.txt | ||
---|---|---|
1 |
@author: Alessia Bardi |
|
2 |
@date: 28 September 2018 |
|
3 |
@title: Info on how to update documentation and changelog for api.openaire.eu |
|
4 |
|
|
5 |
1)---- DOCUMENTATION UPDATE --- |
|
6 |
You just need to simply modify the html files on your local copy of https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/ |
|
7 |
|
|
8 |
2)---- READ THIS BEFORE COMMITTING ON SVN ---- |
|
9 |
Do you want your log message to be visible on http://api.openaire.eu/changelog.html? |
|
10 |
Yes --> Then commit with a nice message that will be publicly available and go to step 3 (example: new API parameter, new schema version) |
|
11 |
No --> Start your log message with the keyword PRIVATE (capital letters) and go to step 4 (typo fixed, changes to this file) |
|
12 |
|
|
13 |
3)---- UPDATE changelog.html ---- |
|
14 |
So, you have committed and you want to update the changelog so that your log message will appear in http://api.openaire.eu/changelog.html. |
|
15 |
To generate an updated changelist of this documentation as html page, run the following commands on your local machine: |
|
16 |
|
|
17 |
cd dnet-api-http-doc/src |
|
18 |
svn log -v --xml https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc | xsltproc svnlog2html.xslt - > ./changelog.html |
|
19 |
svn commit -m "PRIVATE : updated changelist" |
|
20 |
|
|
21 |
Now you can go to step 4 |
|
22 |
|
|
23 |
4)---- PUBLISH UPDATED DOCUMENTATION ---- |
|
24 |
Login via ssh to openaire-www.vls.icm.edu.pl and update the documentation folder /srv/www/api-docs: |
|
25 |
|
|
26 |
sudo /bin/su - www-data -s /bin/bash |
|
27 |
cd /srv/www/api-docs/ |
|
28 |
svn up |
|
29 |
|
|
30 |
Remember to go to api.openaire.eu and double check the changes appear as you expect. If not, double check you committed everything. |
|
31 |
If you have problems with the commit procedure or svn up on the server folder contact Alessia Bardi. |
|
32 |
If you have problems with the layout or visualization of figures, contact Argiro Kokogiannaki. |
Also available in: Unified diff
PRIVATE : updated intenral documentation