Skip to content

README.adoc

Latest commit

 

History

History
70 lines (42 loc) · 3.17 KB

README.adoc

File metadata and controls

70 lines (42 loc) · 3.17 KB
Teragrep Logo

doc_01 – Documentation for Teragrep

The official documentation for Teragrep, accessed on docs.teragrep.com.

Features

The documentation website is generated with Asciidoctor and Antora. The website’s layout is based on Antora Default UI which is licensed under the MPL-2.0 license.

Covered or planned topics:

  • Data Processing Language (DPL) commands

  • How to use Teragrep user interface

  • Teragrep Design System

Technical documentation for Teragrep components can be found in their corresponding repository on GitHub. View the full list of Teragrep components in Teragrep portal repository.

How to Get Started

Note
 To be announced

How to Edit

You need at least a code editor (e.g. Visual Studio Code or WebStorm) for editing the documentation content. The AsciiDoc plugin is recommended but not mandatory.

The documentation is written with AsciiDoc language which resembles Markdown. Read Asciidoctor’s documentation about how to use AsciiDoc syntax correctly.

The documentation content is located in /src/docs directory.

Directory Path Purpose

Attachments

/src/docs/…​/modules/ROOT/attachments

Directory for attachemnts like ZIP archives and PDF files. Read more about attachments.

Images

/src/docs/…​/modules/ROOT/images

Directory for images

Pages

/src/docs/…​/modules/ROOT/pages

Directory for documentation pages. Read more about how to set up a standard page.

The left side navbar is manually maintained by updating the nav.adoc file. Read more about how to update link lists in the navigation file.

How to Deploy

Note
 To be announced

Contributing

You can involve yourself with our project by opening an issue or submitting a pull request.

Contribution requirements:

  1. All changes must be accompanied by a new or changed test. If you think testing is not required in your pull request, include a sufficient explanation as why you think so.

  2. Security checks must pass

  3. Pull requests must align with the principles and values of extreme programming.

  4. Pull requests must follow the principles of Object Thinking and Elegant Objects (EO).

Read more in our Contributing Guideline.

Contributor License Agreement

Contributors must sign Teragrep Contributor License Agreement before a pull request is accepted to organization’s repositories.

You need to submit the CLA only once. After submitting the CLA you can contribute to all Teragrep’s repositories.