Versions Compared

Key

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

...


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 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. Some instructions are at https://jekyllrb.com/docs/installation/ Make sure you update the version of jekyll used by bundle (bundle update)

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

    cd content/ 
    bundle exec jekyll serve

On a VM:  Set up a port forward in VirtualBox's network settings for port 4000. Use the host option with 0.0.0.0 to publish to the host.  

    bundle exec jekyll serve --host 0.0.0.0

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

...

When you are done making changes:

10. Run production option to fix links in the feed.xml and anywhere absolute URLs are used.  Let it generate once and ctrl-C.

    JEKYLL_ENV=production bundle exec jekyll serve


11. Move the content/target folder out of the way, you will commit this separately.

...

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

...

Important note to the person pulling the new changes:  Be sure that the asf-site matches content in master.  It might be safer to ignore the asf-site pull request and compile the modifications from master.

3. The latest commit to asf-site is automatically served as http://rya.apache.org/