Conversation
Contributor
Author
|
The linkcheck is failing due to the absence of SECURITY.md in the branch yet (before the merge). |
akram09
approved these changes
Sep 15, 2026
smethnani
reviewed
Sep 15, 2026
| administrators of this charm. | ||
|
|
||
| Please help us out in ensuring easy-to-review branches by rebasing your pull | ||
| request branch onto the `main` branch. This also avoids merge commits and |
Contributor
There was a problem hiding this comment.
Shouldn't this be 2/edge?
Suggested change
| request branch onto the `main` branch. This also avoids merge commits and | |
| request branch onto the `2/edge` branch. This also avoids merge commits and |
|
|
||
| 1. Create a branch (in the main repository or in a fork) from the current | ||
| `main` and modify the documentation files as necessary. | ||
| 2. Raise a pull request against `main` to start the review process. |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. Raise a pull request against `main` to start the review process. | |
| 2. Raise a pull request against `2/edge` to start the review process. |
| For larger contributions: | ||
|
|
||
| 1. Create a branch (in the main repository or in a fork) from the current | ||
| `main` and modify the documentation files as necessary. |
Contributor
There was a problem hiding this comment.
Suggested change
| `main` and modify the documentation files as necessary. | |
| `2/edge` and modify the documentation files as necessary. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of issue or feature:
We want to get rid of the dedicated contacts page (as it should not be a part of the products documentation directly, as the first-class citizen).
Solution:
We create a contributor's guide, put the contact information there and update all the links.
Additionally, a few minor changes:
We provide additional navigation opportunities for people to navigate to the guide.
We update the CONTRIBUTING.md in the repo to have a link to the Contributor's guide in the docs.
We also add SECURITY.md file as this is best practice to have one at the reoot of our repo.
Finally, we add relative links block to the home page, just because we can.
How was this change tested?
See PR preview.
Checklist