Component Documentation

🕓 10 minutes

CodeNOW implements Swagger Editor for Component API documentation and Draw.io for general diagram creation. The Component documentation is versioned in a separate Git repository alongside the Application Component repositories.

Use these tools to create an individual documentation for each Application Component.

Setting up Component Documentation Git repositories

Prerequisites

• Create a New Application
• Create a New Application Component
• Permissions required for documentation access and editing

Procedure

1. In the left menu column, Click Documentation>Dashboard. The available Applications with their Application Components are displayed.
2. Click Setup Documentation for the Application Component that you want. After a while, Diagrams and API Landscape buttons are displayed.

note

This creates a Git repository <resource-name>-documentation for Draw.io and Swagger instances in GitLab.

Using Swagger Editor in CodeNOW

Prerequisites

• Component Documentation set up.

Procedure

1. Click API Landscape for the Application Component that you want. This redirects to a Swagger Editor instance.
2. GitLab will require an SSO authorization (with the first access).
3. The instance is started with an example .yaml file. The changes made to the .yaml file will be interpreted in real time in the GUI on the right.
4. Click Save to Git to save the .yaml file to the GitLab repository <component-name>-documentation.

Additional references

• Official Swagger Editor documentation

Using Draw.io in CodeNOW

Prerequisites

• Component Documentation set up.

Procedure

1. Click Diagrams for the Application Component that you want. This redirects to a Draw.io instance.
2. GitLab will require an SSO authorization (with the first access).
3. Click File>Save and enter a commit message. This commits the changes to the Draw.io diagram to the GitLab repository <component-name>-documentation.

tip

Official Draw.io documentation