Building documentation

1. Thecore directory stores the basic documentation that can be added as an external dependency (such as git submodule).
2. Theoverlay directory stores content that is specific for this build.
3. The contents of the core directory are copied to the working directory.

As a result, the working directory of the build contains the content from the core directory, in which the files present in the overlay directory are replaced. If a certain file is missing inoverlay, a file from gets to the build.

This overlay allows redefining the content, preserving the placement of articles, that is, keeping any links to them from other articles, whether they come from articles placed incore oroverlay. As a result, content adaptation can be carried out within the article that requires adaptation, without the need to make technical adjustments in other articles.

Warning

Local build with OpenSource tools

The documentation is built using theYFM-Docs utility.

The procedure for installing YFM-Docs is described on.

To build the YDB OpenSource documentation, run the command:

• source_dir is the directory where the contents ofhttps://github.com/ydb-platform/ydb/tree/master/docs is cloned.
• output_dir is the output directory for HTML files.

Building the documentation takes a few seconds and there should be no errors logged to the stdout.

You can specify. (a dot) as if the yfm command is called directly fromsource_dir. For example:

To view the documentation built locally, you can open the directory from your browser or use a simple web server built into Python:

• (in Russian)