Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Some correction in Documentation at install devtron/ configuration / ingress setup #2981

Merged
merged 3 commits into from
Feb 17, 2023

Conversation

jatin-jangir
Copy link
Contributor

@jatin-jangir jatin-jangir commented Feb 16, 2023

URL at these page are not correctly redirecting to their destination.
https://docs.devtron.ai/configurations-overview

Intention of yaml file
metadata:
annotations: nginx.ingress.kubernetes.io/app-root: /dashboard

Description

Fixes #

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Checklist:

  • The title of the PR states what changed and the related issues number (used for the release note).
  • Does this PR requires documentation updates?
  • I've updated documentation as required by this PR.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have tested it for all user roles.
  • I have added all the required unit/api test cases.

Does this PR introduce a user-facing change?


@@ -5,8 +5,8 @@ The configuration allows you to quickly roll back a configuration change if nece

There are two ways you can perform configurations while setting up Devtron dashboard:

* [Installation Configurations](setup/install/installation-configuration.md)
* [Override Configurations](setup/install/override-default-devtron-installation-configs.md)
* [Installation Configurations](https://github.com/devtron-labs/devtron/blob/main/docs/setup/install/installation-configuration.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link will still be broken as its coming from Github (after merging to main). Can you please add the link from the document itself? It is: https://docs.devtron.ai/configurations-overview/installation-configuration

* [Installation Configurations](setup/install/installation-configuration.md)
* [Override Configurations](setup/install/override-default-devtron-installation-configs.md)
* [Installation Configurations](https://github.com/devtron-labs/devtron/blob/main/docs/setup/install/installation-configuration.md)
* [Override Configurations](https://github.com/devtron-labs/devtron/blob/main/docs/setup/install/override-default-devtron-installation-configs.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also setup `ingress` while setting up Devtron dashboard. Refer [here](https://github.com/devtron-labs/devtron/blob/main/docs/setup/install/ingress-setup.md) for ingress setup.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -14,7 +14,8 @@ You can use [this yaml file](https://github.com/devtron-labs/devtron/blob/main/m
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations: nginx.ingress.kubernetes.io/app-root: /dashboard
annotations:
nginx.ingress.kubernetes.io/app-root: /dashboard
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the difference between the previous annotations and the one you corrected?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the previous one will create error regarding indentation in YAML file.
putting them in same line cause error.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, then its fine.

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@jatin-jangir jatin-jangir requested a review from SNe789 February 16, 2023 13:02
@prakarsh-dt prakarsh-dt changed the title Some correction in Documentation at install devtron/ configuration / ingress setup docs: Some correction in Documentation at install devtron/ configuration / ingress setup Feb 17, 2023
@prakarsh-dt prakarsh-dt merged commit 72353ed into devtron-labs:main Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants