Update docs structure for Docsify by mmitoraj · Pull Request #17918 · kyma-project/kyma

mmitoraj · 2023-08-01T13:45:03Z

Changes proposed in this pull request:

Added _sidebar.md files
Consolidate some of the documents

Related issue(s)
#15920

netlify · 2023-08-01T13:45:08Z

✅ Deploy Preview for kyma-project-docs-preview ready!

Name	Link
🔨 Latest commit	`6bfc19e`
🔍 Latest deploy log	https://app.netlify.com/sites/kyma-project-docs-preview/deploys/64cba46ca831590008ac1b07
😎 Deploy Preview	https://deploy-preview-17918--kyma-project-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

pbochynski · 2023-08-01T18:10:08Z

docs/01-overview/_sidebar.md

@@ -0,0 +1,36 @@
+* [Home](/)


Use the other sidebar file (one level up) in the docs root. This one is nested.

Ok. I got your intention. To have components separated from modules.

IwonaLanger · 2023-08-03T10:16:15Z

docs/01-overview/observability/README.md

@@ -24,3 +24,62 @@ You can use the following in-cluster components to observe your applications' te
 > **NOTE:** The Prometheus integration has been [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and is planned to be removed.


Suggested change

> **NOTE:** The Prometheus integration has been [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and is planned to be removed.

> **NOTE:** The Prometheus integration has been [deprecated](https://blogs.sap.com/2022/12/09/deprecation-of-prometheus-grafana-based-monitoring-in-sap-btp-kyma-runtime/) and is planned to be removed.

IwonaLanger · 2023-08-03T10:22:32Z

docs/01-overview/observability/README.md

@@ -24,3 +24,62 @@ You can use the following in-cluster components to observe your applications' te
 > **NOTE:** The Prometheus integration has been [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and is planned to be removed.
 - [Grafana](https://grafana.com/docs/guides/getting_started/) to provide a dashboard and a query editor to visualize metrics collected from Prometheus.
 > **NOTE:** The Grafana integration has been [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and is planned to be removed.


Suggested change

> **NOTE:** The Grafana integration has been [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and is planned to be removed.

> **NOTE:** The Grafana integration has been [deprecated](https://blogs.sap.com/2022/12/09/deprecation-of-prometheus-grafana-based-monitoring-in-sap-btp-kyma-runtime/) and is planned to be removed.

IwonaLanger · 2023-08-03T10:23:04Z

docs/01-overview/observability/README.md

+
+# Monitoring
+
+> **NOTE:** Prometheus and Grafana are [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and are planned to be removed. If you want to install a custom stack, take a look at [Install a custom kube-prometheus-stack in Kyma](https://github.com/kyma-project/examples/tree/main/prometheus).


Suggested change

> **NOTE:** Prometheus and Grafana are [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and are planned to be removed. If you want to install a custom stack, take a look at [Install a custom kube-prometheus-stack in Kyma](https://github.com/kyma-project/examples/tree/main/prometheus).

> **NOTE:** Prometheus and Grafana are [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and are planned to be removed. If you want to install a custom stack, take a look at [Install a custom kube-prometheus-stack in Kyma](https://blogs.sap.com/2022/12/09/deprecation-of-prometheus-grafana-based-monitoring-in-sap-btp-kyma-runtime/).

IwonaLanger · 2023-08-03T10:30:39Z

docs/01-overview/serverless/README.md

+|                               | XL     | L      | M      | S      | XS      |
+|-------------------------------|--------|--------|--------|--------|---------|
+| response time [avarage]       | ~13ms  | 13ms   | ~15ms  | ~60ms  | ~400ms  |
+| response time [95 percentile] | ~20ms  | ~30ms  | ~70ms  | ~200ms | ~800ms  |
+| response time [99 percentile] | ~200ms | ~200ms | ~220ms | ~500ms | ~1.25ms |
+


This table needs fixing.

IwonaLanger · 2023-08-03T10:55:44Z

docs/03-tutorials/README.md

+* [Create a new Application](/03-tutorials/00-application-connectivity/ac-01-create-application.md)
+* [Register a service](/03-tutorials/00-application-connectivity/ac-03-register-manage-services.md)
+* [Register a secured API](/03-tutorials/00-application-connectivity/ac-04-register-secured-api.md)
+* [Call a registered external service from Kyma](/03-tutorials/00-application-connectivity/ac-05-call-registered-service-from-kyma.md)
+* [Disable TLS certificate verification](/03-tutorials/00-application-connectivity/ac-11-disable-tls-certificate-verification.md)
+* [Establish a secure connection with Compass](/03-tutorials/00-application-connectivity/ra-01-establish-secure-connection-with-compass.md)
+* [Maintain a secure connection with Compass](/03-tutorials/00-application-connectivity/ra-02-maintain-secure-connection-with-compass.md)
+* [Revoke a client certificate (RA)](/03-tutorials/00-application-connectivity/ra-03-revoke-client-certificate.md)
+* [Configure Runtime Agent with Compass](/03-tutorials/00-application-connectivity/ra-04-configure-runtime-agent-with-compass.md)
+* [Reconnect Runtime Agent with Compass](docs/03-tutorials/00-application-connectivity/ra-05-reconnect-runtime-agent-with-compass.md)


The links don't work.

IwonaLanger · 2023-08-03T11:33:01Z

docs/05-technical-reference/00-architecture/_sidebar.md

@@ -0,0 +1,2 @@
+* [Technical Reference](/05-technical-reference/README.md)
+  * [Architecture](README.md)


Do we need this file?

IwonaLanger · 2023-08-03T11:40:02Z

docs/05-technical-reference/00-configuration-parameters/README.md

+
+- [Application Connector chart](ac-01-application-connector-chart.md)
+- [Ory limitations](apix-01-ory-limitations.md)
+- [ORY chart](/05-technical-reference/00-configuration-parameters/apix-02-ory-chart.md)


This link doesn't work.

IwonaLanger · 2023-08-03T11:45:55Z

docs/05-technical-reference/00-configuration-parameters/_sidebar.md

@@ -0,0 +1,2 @@
+* [Technical Reference](/05-technical-reference/README.md)


Do we need this file?

IwonaLanger · 2023-08-03T11:48:33Z

docs/05-technical-reference/00-custom-resources/_sidebar.md

@@ -0,0 +1,2 @@
+* [Technical Reference](/05-technical-reference/README.md)


Do we need this file?

IwonaLanger · 2023-08-03T12:25:02Z

docs/03-tutorials/README.md

+* [Create workload](/03-tutorials/00-api-exposure/apix-01-create-workload.md)
+* [Custom domain](/03-tutorials/00-api-exposure/apix-02-setup-custom-domain-for-workload.md)
+* [Expose a workload](/03-tutorials/00-api-exposure/apix-04-expose-workload/apix-04-01-expose-workload-apigateway.md)
+* [Expose multiple workloads](/03-tutorials/00-api-exposure/apix-04-expose-workload/apix-04-02-expose-multiple-workloads.md)
+* [Expose workloads in multiple Namespaces](/03-tutorials/00-api-exposure/apix-04-expose-workload/apix-04-03-expose-workloads-multiple-namespaces.md)
+* [Secure workload with OAuth 2](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-01-expose-and-secure-workload-oauth2.md)
+* [Get a JSON Web Token (JWT)](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-02-get-jwt.md)
+* [Secure a workload with JWT](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-03-expose-and-secure-workload-jwt.md)
+* [Secure a workload with Istio](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-04-expose-and-secure-workload-istio.md)
+* [Secure a workload with a certificate](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-05-expose-and-secure-workload-with-certificate.md)


The links don't work.

kyma-bot · 2023-08-03T13:08:36Z

@mmitoraj: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-kyma-governance	`6bfc19e`	link	false	`/test pull-kyma-governance`

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

Add _sidebar.md to Overview docs

5473c8b

mmitoraj requested a review from a team as a code owner August 1, 2023 13:45

kyma-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 1, 2023

mmitoraj marked this pull request as draft August 1, 2023 13:45

kyma-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 1, 2023

pbochynski reviewed Aug 1, 2023

View reviewed changes

Add _sidebar.md files, consolidate some of the documents

94ca655

kyma-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 2, 2023

mmitoraj marked this pull request as ready for review August 2, 2023 11:03

kyma-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 2, 2023

pbochynski previously approved these changes Aug 2, 2023

View reviewed changes

kyma-bot assigned pbochynski Aug 2, 2023

kyma-bot added the lgtm Looks good to me! label Aug 2, 2023

Update sidebar.md and adjust docs

dd07b55

mmitoraj dismissed pbochynski’s stale review via dd07b55 August 3, 2023 07:02

kyma-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed lgtm Looks good to me! size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 3, 2023

mmitoraj added 3 commits August 3, 2023 09:04

Bring Telemetry docs back

06bd4a4

Technical reference sidebar

ef1083d

Add technical reference sidebar.md files

2d7c5aa

kyma-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 3, 2023

IwonaLanger reviewed Aug 3, 2023

View reviewed changes

Apply Iwona's suggestions from lg review

6bfc19e

IwonaLanger approved these changes Aug 3, 2023

View reviewed changes

kyma-bot assigned IwonaLanger Aug 3, 2023

kyma-bot added the lgtm Looks good to me! label Aug 3, 2023

kyma-bot merged commit 90134c0 into kyma-project:main Aug 3, 2023

mmitoraj deleted the docsify-structure branch August 4, 2023 06:55

nataliasitko mentioned this pull request Aug 4, 2023

Fix broken links #17935

Merged

		@@ -24,3 +24,62 @@ You can use the following in-cluster components to observe your applications' te
		> NOTE: The Prometheus integration has been [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and is planned to be removed.

	> NOTE: The Grafana integration has been [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and is planned to be removed.
	> NOTE: The Grafana integration has been [deprecated](https://blogs.sap.com/2022/12/09/deprecation-of-prometheus-grafana-based-monitoring-in-sap-btp-kyma-runtime/) and is planned to be removed.


		# Monitoring

		> NOTE: Prometheus and Grafana are [deprecated](https://kyma-project.io/blog/2022/12/9/monitoring-deprecation) and are planned to be removed. If you want to install a custom stack, take a look at [Install a custom kube-prometheus-stack in Kyma](https://github.com/kyma-project/examples/tree/main/prometheus).

		@@ -0,0 +1,2 @@
		* [Technical Reference](/05-technical-reference/README.md)
		* [Architecture](README.md) No newline at end of file

Conversation

mmitoraj commented Aug 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Aug 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for kyma-project-docs-preview ready!

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!

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!

kyma-bot commented Aug 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mmitoraj commented Aug 1, 2023 •

edited

Loading

netlify bot commented Aug 1, 2023 •

edited

Loading