Skip to content

docs - Add contributor's guide and refactor contacts - #853

Open
izmalk wants to merge 1 commit into
canonical:2/edgefrom
izmalk:contacts-update
Open

izmalk wants to merge 1 commit into
canonical:2/edgefrom
izmalk:contacts-update

Conversation

@izmalk

@izmalk izmalk commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

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?

  • Manually
  • Unit tests
  • Integration tests

See PR preview.

Checklist

  • I have added or updated any relevant documentation.
  • I have cleaned any remaining cloud resources from my accounts.

@izmalk izmalk self-assigned this Sep 9, 2026
@izmalk

izmalk commented Sep 9, 2026

Copy link
Copy Markdown
Contributor Author

The linkcheck is failing due to the absence of SECURITY.md in the branch yet (before the merge).

@smethnani smethnani left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @izmalk! Just a comment on the branch but otherwise LGTM!

Comment thread docs/contributing.md
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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Comment thread docs/contributing.md

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread docs/contributing.md
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
`main` and modify the documentation files as necessary.
`2/edge` and modify the documentation files as necessary.

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