Versions Compared

Key

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

...

  1. Pull the latest changes from the website's master branch.
  2. Go to the ignite_website_root/_docs directory.
  3. Run the `./build.sh --version={version} --github-branch={branch} --latest` command to transform the docs from the AsciiDoc to the HTML format, and add the HTML files to the website repository
    The script pulls the given branch from the apache-ignite code base repository and generates the docs from the adoc files. The resulting HTML files are located in the "/docs" directory. 
    For example:
    ./build.sh --version=2.9.0 --github-branch=IGNITE-2.9 --latest
  4. Change that the version of the docs was generated without issues using your local installation of the website: http://localhost/docs/latest/
  5. Push the generated files to the ignite website master. They will be published automatically.
  6. Check that the version was published successfully on the Ignite website: https://ignite.apache.org/docs/latest/

Updating Published Docs

Use the same command to generate an updated version of already released docs but do NOT specify the "–latest" flag:

 ./build.sh --version=2.8.0 --github-branch=IGNITE-2.8-docs


As for the rest, follow the procedure described in the Publishing New Version section above.


Documentation Maintainers


Docs ScopeMaintainers

Global readme.io All docs maintainers

(assign for final docs review)

Denis Magda (dmagda@apache.org)

.NET readme.io -specific docs maintainers

Pavel Tupitsyn (ptupitsyn@apache.org)

C++ readme.io docs maintainers, Python, Node.JS, PHP-specific docs

Igor Sapego (isapego@gridgain.com)