Skip to content
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

Updating the InaSAFE website should be automated #257

Closed
timlinux opened this issue Sep 6, 2012 · 2 comments
Closed

Updating the InaSAFE website should be automated #257

timlinux opened this issue Sep 6, 2012 · 2 comments

Comments

@timlinux
Copy link
Contributor

timlinux commented Sep 6, 2012

In describing the process to update the website to Marco I realised that there are too many steps and it is quite likely for something to go wrong, so I think we should automate the process as much as possible. For example we should have a script invoked with a make target:

make update-website

Here is the log from irc of the general logic that should be implemented for the script:

08:39 <@timlinux> cd ..
08:39 <@timlinux> test if inasafe-gh-pages dir exists
08:40 <@timlinux> if no clone inasafe
08:40 <@timlinux> into inasafe-gh-pages
08:40 <@timlinux> cd inasafe-gh-pages
08:40 <@timlinux> git branch --trach gh-pages origin/gh-pages
08:40 <@timlinux> git checkout gh-pages
08:40 <@timlinux> if yes
08:41 <@timlinux> cd inasafe-gh-pages
08:41 <@timlinux> git pull
08:41 <@timlinux> cd ..
08:41 <@timlinux> cd inasafe-dev
08:41 <@timlinux> make docs
08:41 <@timlinux> cd ..
08:41 <@timlinux> cd inasafe-gh-pages
08:41 <@timlinux> rm all generated content
08:42 <@timlinux> cp all generated content from ../inasafe-dev/docs/build/html
08:42 <@timlinux> git status
08:42 <@timlinux> git add any newly arrived files
08:42 <@timlinux> git commit -m 'Automated docs update'
08:42 <@timlinux> git push
08:42 <@timlinux> cd ..
08:42 <@timlinux> cd inasafe-dev

Ultimately we could run this make target using jenkins whenever a commit happens or nightly.

@ghost ghost assigned mbernasocchi Sep 6, 2012
@ismailsunni
Copy link
Member

May be we can put the script for generating .rst file (for API doc) https://github.com/AIFDR/inasafe/blob/master/scripts/gen_rst_script.py before make docs so the API documentation is updated also.

@mbernasocchi
Copy link
Collaborator

ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants