-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add script to update docs on knora.org #300
Conversation
If I understand correctly, the branch Your script builds the docs, switches the local branch to
Ok, I understood that www.knora.org points to the current version of |
set -e | ||
|
||
# Build the HTML docs. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add a check that the current branch is develop
:
branch=`git rev-parse --abbrev-ref HEAD`
# Switch to the gh-pages branch and remove the existing HTML docs from it. | ||
|
||
git checkout gh-pages | ||
rm -rf ../documentation/manual |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are just deleting all the files. However, they remain under version control appearing as missing in git. I think you should use git rm
. Imagine the case that someone removes a file from the docs. It will appear as missing in gh-pages
although it is no longer under version control in the docs
folder.
… pushing docs to gh-pages.
* develop: Improve configuration for more concurrent requests (#338) Upgrade to Scala 2.12 (#343) Fix various inconsistencies in knora-base.ttl and docs. (#330) Fix language switching and login/logout in SALSAH (#331) Graph data API operation (#267) Allow connections over HTTPS (#332) Update README.md Add link to GraphDB. fix (salsah): Add missing JavaScript “var”. fix (webapi): Fix RouteUtilV1 so it returns HTML instead of JSON when requested (#326) Ontology and documentation fixes. (#325) fix (salsah): Create multiple links in a resource, and other bug fixes (#315) feature (webapi): Make TransformData fix “test” labels on regions. (#311) Fixes for subclasses and subproperties (#303) Add script to update docs on knora.org (#300) docs: Make trivial change for testing purposes. fix (webapi): CORS problems (#307) Use inference to optimise searches on GraphDB (#301)
This adds a script that you can run manually to update the documentation on knora.org when the RST or generated API docs have changed.
The script assumes that you're on the
develop
branch and have already committed any changes you made there. It builds the docs and updates thegh-pages
branch with the resulting HTML.In the future we could automate this to run every time
develop
is updated.