Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.76 KB

01-user-docs.md

File metadata and controls

49 lines (34 loc) · 2.76 KB
Raw

User Documentation

Open-source Kyma and Kyma module user documentation is displayed at https://kyma-project.io. The website uses docsify as a documentation site generator.

The overarching Kyma content is pulled from the /docs folder in the /kyma repository. Module documentation is pulled from the /docs/user folder in respective module repositories.

After initialization, to run, docsify uses the following files located in the /docs folder in the /kyma repository:

  • index.html for configuration
  • README.md as the home page
  • .nojekyll preventing GitHub Pages from ignoring files that begin with an underscore
  • _sidebar.md listing all Markdown documents to be displayed and ruling navigation between those documents on the website

Publish a Document from the /kyma Repository

To publish a document located in the /kyma repository, follow these steps:

  1. Create a pull request adding your content to a Markdown file located in the /docs folder.
  2. Add a new _sidebar.md file including a link to your document, or update an existing _sidebar.md to include it.

Publish a Document from an Existing Module Repository

To publish a document located in an existing module repository, follow these steps.

  1. Create a pull request adding your content to a Markdown file located in the /docs/user folder in your module repository.
  2. In the docs/user folder, add a new _sidebar.md file including a link to your document, or update the existing _sidebar.md to include it.

Publish a Document from a New Module Repository

To publish a document located in a new module repository, follow the steps from Publish a document from an existing module. Once completed, do the following:

  1. In the /kyma repository, open the /kyma/docs/_sidebar.md file and under Modules, add a link to your module documentation main page.
  2. Update index.html by adding a new alias entry in the part. Use the following pattern:
```html
alias: {
'/{MODULE_REPOSITORY_NAME}/(.*)': 'https://raw.githubusercontent.com/{GITHUB_PROJECT_NAME}/{MODULE_REPOSITORY_NAME}/main/docs/$1',
}, 
```

For example:

```html
alias: {
'/serverless-manager/(.*)': 'https://raw.githubusercontent.com/kyma-project/serverless-manager/main/docs/$1',
}, 
```

CAUTION: When you update navigation paths in documentation, make sure you check all _sidebar.md files that may be affected.