Versions Compared

Key

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

...

  1. Clone the main Ignite repository and get to know our development process. You can fork the repository or have a clone of the main repository on your local machine.
  2. Make sure a JIRA ticket is created for the change and the component property is set to documentation.
  3. Find documentation sources under the ignite_root/docs/_docs directory and do necessary modifications:

    • Refer to the How to Contribute section of the documentation module to understand the syntax of the AsciiDoc format and the rest of the files located under the _docs directory.
    • Update the ignite_root/docs/_docs/toc.yaml file if you add a new documentation page.
    • Every new documentation page must include the Apache 2.0 license header. 
  4. Do a grammar check of your changes. Use Grammarly if you don't have a more advanced tool at hand.

  5. Build the docs locally to test that your changes are applied properly and you didn't break anything.
  6. If you added a new page or imported any external files, run the license checker: `mvn clean validate -DskipTests=true -P check-licenses`

  7. Send a pull-request, request the review from documentation maintainers.

  8. Merge the changes after passing the review and after you confirm that all the automated checks performed by Travis CI are passed.

...

https://github.com/apache/ignite-website/blob/master/.htaccess

Reach out to documentation maintainers if you need any help with this.

Publishing to the Website

While the documentation sources are stored in the AsciiDoc format in the main Ignite repository, the version of the docs, that is published on the website, is stored in the Ignite website repo in the HTML format. This section explains how to publish documentation changes to the website.

Prerequisite 

Publishing New Version

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

...

  1. latest
  2. Change that the version of the docs was generated without issues using your local installation of the website: http://localhost/docs/latest/
  3. Push the generated files to the ignite website master. They will be published automatically.
  4. Check that the version was published successfully on the Ignite website: https://ignite.apache.org/docs/latest/

Updating Published Docs


Documentation Maintainers

...