Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added details to how to modify website

...


3. Modify the markdown as needed using a text editor.
4. New releases go in folder _posts along with other news.
5. Releases must use the prescribed file naming format and have a header variable catagories=release along with some other variables describing the version.
6. The file download.md, using its scripts, should automatically populate the coresponding html based on your new post file and its variables, but it may need tweaking.

7. Install Jekyll.  This may not be straight forward if you don't have a ruby environment.  You may have to add Linux distro packages, then ruby gems, then more packages as dependencies present themselves.

8. Run this command in the content/ folder to auto-compile and web serve on port 4000:

    cd content/ 
    bundle exec jekyll serve


9. Now just iteratively  use your editor and web browser to edit and test changes.

10. When you are done making changes:
11. Move the content/target folder out of the way, you will commit this separately.

    mv content/target/ ../

12. Commit changes, add a remote to your own public git repo, and push to it with --set-upstream.

12.1 commit changes

    git add [new and modified files]
    git commit -a -m "say what you changed here"

12.2 add a remote to your own public git repo, for example

    git remote add your_username https://github.com/your_username/incubator-rya-site.git

12.3 push

    git push your_username your_branch_name_here --set-upstream

13. Create a pull request to the repo apache/incubator-rya-site branch master.

   Here is a guide https://help.github.com/articles/creating-a-pull-request-from-a-fork/

 

14. Now for the deployable HTML that you moved above:
15. In the same git folder,

    git checkout --force origin/asf-site
    git checkout -b another_new_branch_name_here
    rm -r content
Note: --force might remove any stray files left over.
Note: replace another_new_branch_name_here with a new branch hinting at your changes.
Note: the recursive remove of all the content is necessary to discover files deleted as well as changed.

16. Now copy the folder formally named target/ into the project, renaming it to content/.

...