Adding a README.md about how to update the website.
Project: http://git-wip-us.apache.org/repos/asf/incubator-crail-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-crail-website/commit/2ed7b32f Tree: http://git-wip-us.apache.org/repos/asf/incubator-crail-website/tree/2ed7b32f Diff: http://git-wip-us.apache.org/repos/asf/incubator-crail-website/diff/2ed7b32f Branch: refs/heads/master Commit: 2ed7b32f0d6499c72d86b28bf14c366668ad1cde Parents: b0cff03 Author: Animesh Trivedi <animesh.triv...@gmail.com> Authored: Thu Feb 8 18:42:31 2018 +0100 Committer: Animesh Trivedi <animesh.triv...@gmail.com> Committed: Thu Feb 8 18:42:31 2018 +0100 ---------------------------------------------------------------------- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-crail-website/blob/2ed7b32f/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..5fd9045 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +## How to update the Crail website. + +Please make necessary changes in the master branch. You can test +the master branch by + 1. Changing the 'base` in the site/_config.yml from base: + 'http://crail.incubator.apache.org' to + 'http://127.0.0.1:4000' + 2. Run the script "test-locally.sh" to test your setup locally. + +Once you are satisfied with your changes, please change the +site/_config.yml back, and commit your changes to the master +branch. + +Once you are done pushing all changes to the master branch, run +"publish.sh" script. This script will build the new website and +commit the newly generated pages to the "asf-site" branch. If all +goes well, you just need to push the new commit to the branch by +calling "git push origin asf-site". + +After this, you switch back to the "master" branch. + +- The master contains the source in 'master/site'. +- The build site is checked into the 'asf-site/content'. + +https://issues.apache.org/jira/browse/CRAIL-1
