Update documentation due to the VitePress migration by grego952 · Pull Request #1005 · kyma-project/community

grego952 · 2025-10-31T12:08:08Z

Description

Changes proposed in this pull request:

Update documentation due to the VitePress migration

Related issue(s)

docs/guidelines/content-guidelines/01-user-docs.md

docs/guidelines/content-guidelines/03-formatting.md

docs/guidelines/content-guidelines/05-tabs-toggles.md

Co-authored-by: Nina Hingerl <76950046+NHingerl@users.noreply.github.com>

mmitoraj · 2025-11-20T13:08:35Z

docs/guidelines/content-guidelines/01-user-docs.md

+   },
+   ```
+
+   If you want to add documentation for a new module, you must also add the module repository name do the `deploy.yml` file, under `jobs.copy-docs.strategy.matrix.repository`. For example:


I would say this is step 4.

Suggested change

If you want to add documentation for a new module, you must also add the module repository name do the `deploy.yml` file, under `jobs.copy-docs.strategy.matrix.repository`. For example:

4. In the `/kyma` repository, add the module repository name to the [`deploy.yml`](https://github.com/kyma-project/kyma/blob/main/.github/workflows/deploy.yml) file under the **jobs.copy-docs.strategy.matrix.repository** element. For example:

mmitoraj · 2025-11-20T13:19:59Z

docs/guidelines/content-guidelines/01-user-docs.md


 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.
+2. Add a new `_sidebar.ts` file including a link to your document, or update an existing `_sidebar.ts` to include it.


Suggested change

2. Add a new `_sidebar.ts` file including a link to your document, or update an existing `_sidebar.ts` to include it.

2. Go to [`/kyma/.vitepress/config.mjs`](https://github.com/kyma-project/kyma/blob/main/.vitepress/config.mjs#L138) and provide your document details in the **sidebar** element, under **themeConfig**. Use the following pattern:

We could also add the example:

{ text: 'Troubleshooting', link: '/04-operation-guides/troubleshooting/README', },

docs/guidelines/content-guidelines/01-user-docs.md

mmitoraj · 2025-11-20T13:37:19Z

docs/guidelines/content-guidelines/01-user-docs.md

-> **CAUTION:** When you update navigation paths in documentation, make sure you check all `_sidebar.md` files that may be affected.
+> **CAUTION:** When you update navigation paths in documentation, make sure you check all `_sidebar.ts` files that may be affected.
+
+4. Run the [Deploy VitePress site to GitHub Pages](https://github.com/kyma-project/kyma/actions/workflows/deploy.yml) or wait for the CronJob to start it (every day at midnight).


Suggested change

4. Run the [Deploy VitePress site to GitHub Pages](https://github.com/kyma-project/kyma/actions/workflows/deploy.yml) or wait for the CronJob to start it (every day at midnight).

5. Run the [Deploy VitePress site to GitHub Pages](https://github.com/kyma-project/kyma/actions/workflows/deploy.yml) or wait for the CronJob to start it (every day at midnight).

mmitoraj · 2025-11-20T13:38:08Z

docs/guidelines/content-guidelines/01-user-docs.md

+> **CAUTION:** When you update navigation paths in documentation, make sure you check all `_sidebar.ts` files that may be affected.
+
+4. Run the [Deploy VitePress site to GitHub Pages](https://github.com/kyma-project/kyma/actions/workflows/deploy.yml) or wait for the CronJob to start it (every day at midnight).
+5. Make sure that the `public` folder is deleted after the build. If not, delete it manually to clean up the environment.


Suggested change

5. Make sure that the `public` folder is deleted after the build. If not, delete it manually to clean up the environment.

6. Make sure that the `public` folder in the root of the `/kyma` repository is deleted after the build. If not, delete it manually to clean up the environment.

mmitoraj · 2025-11-20T13:41:12Z

docs/guidelines/content-guidelines/01-user-docs.md

+
+## Execute Prettier
+
+Prettier helps maintain proper formatting. The project is already configured to use this formatter automatically, provided you are using Visual Studio Code (it leverages the VSCode Prettier plugin). Unfortunately, it runs prettier at commit time on Git; if you are not using Git integrated in VSCode for commits, you must execute it manually by running the following command:


I'm not sure if I understand. So if I'm using Visual Studio Code, do I need to install the VSC Prettier plugin?

I'll rephrase that.

mmitoraj · 2025-11-20T13:43:12Z

docs/guidelines/content-guidelines/10-docs-preview.md

+Before you publish new documentation on the Kyma website, you can preview your changes to see if the formatting of the text is correct, images fit well, and links work as expected. To do that, see the following steps:

-That is possible thanks to the [**docsify preview feature**](https://docsify.js.org/#/quickstart?id=preview-your-site) supported by [docsify](https://docsify.js.org/#/).
+1. Go to the [`kyma/hack`](https://github.com/kyma-project/kyma/tree/main/hack), and execute the `copy_external_content.sh` script:


Do the files in the hack folder also need to be updated once we add a new module repo? For example, https://github.com/kyma-project/kyma/blob/main/hack/copy_external_content.sh?

Definitely!

I added a note.

Co-authored-by: Małgorzata Świeca <malgorzata.swieca@sap.com>

docs/guidelines/content-guidelines/01-user-docs.md

mmitoraj · 2025-11-21T08:09:59Z

docs/guidelines/content-guidelines/01-user-docs.md

+   ```mjs
+   {
+      text: 'My Module',
+      link: '/external-content/my-module/docs/user/README.md',
+      collapsed: true,
+      items: makeSidebarAbsolutePath(
+        myModuleSidebar,
+        'my-module',
+      ),
+   },
+   ```


Please indent the code example.

mmitoraj · 2025-11-21T08:10:21Z

docs/guidelines/content-guidelines/01-user-docs.md

+   ```yaml
+   jobs:
+     copy-docs:
+       strategy:
+         matrix:
+           repository:
+             - btp-manager
+             - istio
+             - serverless
+             - {YOUR_MODULE_REPO}
+   ```


Please make sure it is indented under the step.

docs/guidelines/content-guidelines/10-docs-preview.md

mmitoraj · 2025-11-21T08:19:26Z

docs/guidelines/content-guidelines/10-docs-preview.md

+   ```bash
+   npm install
+   npm run docs:dev
+   ```


Could you indent it under the bullet point?

mmitoraj · 2025-11-21T08:19:38Z

docs/guidelines/content-guidelines/10-docs-preview.md

+   ```bash
+   npm run docs:build
+   npm run docs:preview
+   ```


Could you indent it under the bullet point?

Co-authored-by: Małgorzata Świeca <malgorzata.swieca@sap.com>

grego952 added 2 commits October 31, 2025 13:05

Update documentation due to the VitePress migration

62280a9

Fix formatting

8df684f

grego952 requested a review from a team as a code owner October 31, 2025 12:08

mmitoraj reviewed Nov 3, 2025

View reviewed changes

docs/guidelines/content-guidelines/01-user-docs.md Outdated Show resolved Hide resolved

Change deploy section due to the recent changes

e8b3a12

NHingerl reviewed Nov 12, 2025

View reviewed changes

docs/guidelines/content-guidelines/03-formatting.md Outdated Show resolved Hide resolved

NHingerl reviewed Nov 12, 2025

View reviewed changes

docs/guidelines/content-guidelines/05-tabs-toggles.md Outdated Show resolved Hide resolved

NHingerl reviewed Nov 12, 2025

View reviewed changes

docs/guidelines/content-guidelines/05-tabs-toggles.md Outdated Show resolved Hide resolved

grego952 and others added 10 commits November 20, 2025 06:58

Merge branch 'main' into docsify-to-vitepress

6c0b314

Remove IMPORTANT alert

ca135b6

Apply suggestions from Nina's review

3f7d2b1

Co-authored-by: Nina Hingerl <76950046+NHingerl@users.noreply.github.com>

Remove IMPORTANT alert

0ce23a9

Add Preview instructions and section about prettier

959f463

Update section of prettier

7e30351

Fix formatting

385faf5

Fix formatting

cb608bf

Add info on deploy

eb06b0d

Add more info on Development and Production modes

a97b114

mmitoraj reviewed Nov 20, 2025

View reviewed changes

grego952 and others added 2 commits November 21, 2025 08:24

Apply suggestions from mmitoraj review

8270e55

Co-authored-by: Małgorzata Świeca <malgorzata.swieca@sap.com>

Apply remaining suggestions

15bb6d6

mmitoraj reviewed Nov 21, 2025

View reviewed changes

grego952 and others added 5 commits November 21, 2025 10:32

Apply suggestions from code review

6e55eea

Co-authored-by: Małgorzata Świeca <malgorzata.swieca@sap.com>

Indent the code

05bbb19

Fix code formatting

5c1b8fb

Fix code formatting

f5767af

Fix numbering

eca2986

mmitoraj approved these changes Nov 21, 2025

View reviewed changes

grego952 merged commit 9c4e3e9 into kyma-project:main Nov 21, 2025
1 of 2 checks passed

grego952 deleted the docsify-to-vitepress branch November 21, 2025 10:00

	If you want to add documentation for a new module, you must also add the module repository name do the `deploy.yml` file, under `jobs.copy-docs.strategy.matrix.repository`. For example:
	4. In the `/kyma` repository, add the module repository name to the [`deploy.yml`](https://github.com/kyma-project/kyma/blob/main/.github/workflows/deploy.yml) file under the jobs.copy-docs.strategy.matrix.repository element. For example:

	2. Add a new `_sidebar.ts` file including a link to your document, or update an existing `_sidebar.ts` to include it.
	2. Go to [`/kyma/.vitepress/config.mjs`](https://github.com/kyma-project/kyma/blob/main/.vitepress/config.mjs#L138) and provide your document details in the sidebar element, under themeConfig. Use the following pattern:

	4. Run the [Deploy VitePress site to GitHub Pages](https://github.com/kyma-project/kyma/actions/workflows/deploy.yml) or wait for the CronJob to start it (every day at midnight).
	5. Run the [Deploy VitePress site to GitHub Pages](https://github.com/kyma-project/kyma/actions/workflows/deploy.yml) or wait for the CronJob to start it (every day at midnight).

	5. Make sure that the `public` folder is deleted after the build. If not, delete it manually to clean up the environment.
	6. Make sure that the `public` folder in the root of the `/kyma` repository is deleted after the build. If not, delete it manually to clean up the environment.


		## Execute Prettier

		Prettier helps maintain proper formatting. The project is already configured to use this formatter automatically, provided you are using Visual Studio Code (it leverages the VSCode Prettier plugin). Unfortunately, it runs prettier at commit time on Git; if you are not using Git integrated in VSCode for commits, you must execute it manually by running the following command:

Conversation

grego952 commented Oct 31, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants