Versions Compared

Key

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

...

The project git@github.com:apache/incubator-rya-site.git  (https://github.com/apache/incubator-rya-site) 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://github.com/apache/incubator-rya-site.git
    cd incubator- rya-site/

2. Create a new branch:

    git checkout -b your_new_branch_name_here

...

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 build

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

...

    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/

...

1. Review the setup here:  https://pages.github.com/  using "project-site"
2. It doesn't mention it in the quick start above, but it will also publish a site from a branch named "gh-pages" which is important since master is already used for another purpose.
3. Start with your branch of project "incubator-rya-site" as pushed to your remote, that is based on the asf-site branch.
4. Create and checkout a new branch named "gh-pages".  This will not be used in a pull request.

    git checkout -b gh-pages
  
5. Move the contents of the "content" folder to the root of the project.
6. Modify each HTML page prepending to all references (href= and src=) to the site with "/incubator-rya-site" .  Ignore references beginning with http.

For example:

    Before:
    
        <link href="/assets/themes/apache/bootstrap/css/bootstrap.css" rel="stylesheet">
        
    After:
    
        <link href="/incubator-rya-site/assets/themes/apache/bootstrap/css/bootstrap.css" rel="stylesheet">


This command should do the replacement:

    find . -name \*.html -exec sed -ri 's/=\"\//=\"\/incubator-rya-site\//g' {} \;


7. Commit changes and push to your public github project named incubator- rya-site.

    git commit -a -m "New stuff"
    
    git push  git push --set-upstream yourGitHub gh-pages
    
8. Login to your github account and to the project incubator- rya-site forked from apache/incubator-rya-site, and click on the Settings tab.  Scroll down to GitHub Pages  and choose source=gh-pages branch.  Save.
    
9. Browse to the site:

    https://yourGitHubID.github.io/incubator-rya-site
    
replacing yourGitHubID with your GitHub account ID.

10. Check your work and ask others to review by sending this URL.

...