Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Apache Rya Web site source

The project gitgit@github.com:apache/incubator-rya-site.git  (https://gitgithub.com/apache.org/incubator-rya-site.git (and the Github mirror) is the markdown source code of the official Apache Rya website.
- master branch is the source in markdown for the Jekyll tool.
- asf-site branch is the compiled HTML that is deployed to the webserver.

...

To make changes to the website:

1. Clone incubator-rya-site branch master:

    git clone https://git-wip-us.apache.org/repos/asfgit@github.com:apache/incubator-rya-site.git
    cd incubator-rya-site/

...


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 corresponding 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

Alternatively, you can use docker to build and serve the site:

export JEKYLL_VERSION=3.8

docker run --name incubator-rya-site --volume="$PWD:/srv/jekyll" --volume="$PWD/vendor/bundle:/usr/local/bundle" -p 3000:4000 -it jekyll/jekyll:$JEKYLL_VERSION jekyll serve

open a browser to http://localhost:3000/


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

...

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


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/.

...