Skip to content

Commit

Permalink
Use footnote
Browse files Browse the repository at this point in the history
  • Loading branch information
mmitoraj committed Oct 23, 2024
1 parent 10eb89c commit 0e51c69
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Overview

The `docs` folder contains three subfolders - `user`, `contributor`, and `operator`[*].
The `docs` folder contains three subfolders - `user`, `contributor`, and `operator`[^*].

The `user` subfolder contains the end-user documentation, which is displayed on the [Kyma website](https://kyma-project.io/#/) and in the SAP Help Portal. Depending on your module needs, the subfolder must include overview, usage, or technical reference documents. To display the content on the website properly, create a `_sidebar.md` file in the `user` subfolder and list the documents it contains there. For more information on how to publish user documentation, follow [this guide](https://github.com/kyma-project/community/blob/main/docs/guidelines/content-guidelines/01-user-docs.md).

The `contributor` subfolder includes any developer-related documentation to help them manually install, develop, and operate a module.

[*]The `operator` subfolder is mandatory only if your module/component is delivered to restricted markets. The subfolder includes documentation relevant to the respective operators.
[^*] The `operator`* subfolder is mandatory only if your module/component is delivered to restricted markets. The subfolder includes documentation relevant to the respective operators.

To have a common structure across all modules, all documents must be properly numbered according to the following structure:

Expand Down

0 comments on commit 0e51c69

Please sign in to comment.