Contains documentation of the AET System.
Below are basic rules how to write documentation.
- The
wiki
directory contains the documentation, that should be uploaded to the project's wiki repository. - GitHub wiki does not handle hierarchy of pages and directories. This means, that each markdown file's name has to be unique, even if pages are placed in different directories. Pages are being referenced by file name without extension or path.
- All assets (images etc.) should be placed in
wiki/assets
directory and referenced asassets/<fileName>
. Here relative path to directory is required. _Sidebar.md
file defines the structure of navigation sidebar placed on the right side on GitHub wiki. It contains links to documentation pages. All pages should be linked in this file.DocumentationTemplate.md
file defines the structure of released version documentation file. All documentation files have to be included in this file in correct order, preferably in the same order as in_Sidebar.md
file.- Use only
#
style headings. TOC in generated released version documentation is based on headings and alternative heading styles are not supported. - Use different heading levels. Hierarchy in TOC of released version documentation is based on heading levels.
Below are instructions how to prepare documentation of a new released application version and how to upload it to GitHub wiki.
node.js
installed.
- Make sure that
package.json
file contains correct version number. - Run maven build with
process-docs
profile. - There should be compiled single page
Documentation-<version>.md
file inwiki/releases/<version>
directory. - Check generated TOC in
Documentation-<version>.md
. You can modify its heading if you want. - Add link to generated release file to
wiki/_Sidebar.md
file if it is not present. Note that link target should be just page name without path and extension, ie.Documentation-1.0.0.md
rather thanreleases/Documentation-1.0.0.md
. - Commit changes to main AET repository.
- Copy contents of
wiki
directory to main directory of github wiki repository, commit and push changes.
- Wiki pages cannot contain regular expressions inside inline block codes since it causes issues with generating of release documentation file. E.g. `^.*js` is not allowed.
- Links to other wiki pages are currently not processed by release documentation generation process, hence the links in release documentation are leading to the pages from current documentation.