update README
1 file changed
tree: 66a0ddac8cac374097397401835ca76db1f7f348
  1. .gitignore
  2. .ruby-version
  3. 404.html
  4. Gemfile
  5. Gemfile.lock
  6. LICENSE
  7. README.md
  8. _config.yml
  9. _data/
  10. _docs/
  11. _includes/
  12. _layouts/
  13. _pages/
  14. _posts/
  15. _sass/
  16. allposts.html
  17. apidocs/
  18. assets/
  19. content/
  20. css/
  21. favicon.ico
  22. fonts/
  23. img/
  24. index.html
  25. js/
  26. publish.sh
  27. resources/
  28. search.json
README.md

Apache Nemo Website

This repo contains the materials of the Apache Nemo incubator project (https://github.com/apache/incubator-nemo). Please find the instructions below on the Filling up documents and Publishing sections for the information required to update the website.

Go to the website for the theme for detailed information and demo for the Jekyll theme used in this project.

Prerequisites

You need to have ruby and bundler gem installed. Run $ bundler install after you've met the prerequisites to be able to run the jekyll project.

Running locally

You need Ruby and gem before starting, then:

# install bundler
gem install bundler

# go to `docs` folder
# install & run jekyll with dependencies
bundler install
bundler exec jekyll serve

Filling up documents

You can find the docs under _docs and the metadata under the _data folder. _posts include blog posts, and _pages include the specific pages of the website. Please refer to them when you wish to update the contents of the website. When you wish to update the javadocs, simply update the apidocs folder.

Publishing

When all contents are fixed, run $ ./publish.sh, add the files, commit, and push the files to github to publish the changes.

Jekyll stuff

You can find Jekyll introduction docs below:

Jekyll Docs

License

Released under the MIT license.