1. Install Jekyll by following this instruction: https://jekyllrb.com/docs/installation/

2. In the “/docs” directory, run the following command:

   $ bundle

   This should install all dependencies, including asciidoctor.

3. Start jekyll:

   $ bundle exec jekyll s

   The command compiles the Asciidoc files into HTML pages and starts a local webserver.

Open http://localhost:4000/docs in your browser.

The following command starts jekyll in a container and downloads all dependencies. Run the command in the “/docs” directory.

Open http://localhost:4000/docs in your browser.

Below are some issues you might hit during an installation of the Jekyll environment or while building the tutorials. Let us know if you come across a new and found a workaround.

The table of content is defined in the _data/toc.yaml file. If you want to add a new page, make sure to update the TOC.

If you rename an already published page or change the page’s path in the /_data/toc.yaml file, you must configure a proper redirect from the old to the new URL in the following files of the Ignite website: https://github.com/apache/ignite-website/blob/master/.htaccess

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

All .adoc files are located in the "docs/_docs" directory. Any link to the files within the directory must be relative to that directory. Remove the file extension (.adoc).

For example:

This is a link to the Native Persistence page.

When referencing an external resource, make the link to open in a new window by adding the window=_blank attribute:

We use custom syntax to insert tabs. Tabs are used to provide code samples for different programming languages.

Tabs are defined by the tabs block:

Each tab is defined by the 'tab' directive:

where tab_name is the title of the tab.

The content of the tab is everything that is given between the tab title, and the next tab or the end of the block.

Use the syntax below if you need to bring reader’s attention to some details:

Change the callout type to CAUTION if you want to put out a warning:

Code snippets must be taken from a compilable source code file (e.g. java, cs, js, etc). We use the include feature of asciidoc. Source code files are located in the docs/_docs/code-snippets/{language} folders.

To add a code snippet to a page, follow these steps:

• Create a file in the code snippets directory, e.g. _docs/code-snippets/java/org/apache/ignite/snippets/JavaThinClient.java

• Enclose the piece of code you want to include within named tags (see https://asciidoctor.org/docs/user-manual/#by-tagged-regions). Give the tag a self-evident name. For example:

  [source, java]
  ----
  // tag::clientConnection[]
  ClientConfiguration cfg = new ClientConfiguration().setAddresses("127.0.0.1:10800");
  try (IgniteClient client = Ignition.startClient(cfg)) {
      ClientCache<Integer, String> cache = client.cache("myCache");
      // get data from the cache
  }
  // end::clientConnection[]
  ----

• Include the tag in the adoc file:

  include::{javaCodeDir}/JavaThinClient.java[tag=clientConnection,indent=0]