chore: Update repo README and CONTRIBUTING section #1439
Merged
Conversation
This file contains 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
Add more details about where to make changes, apply-patch script, and creating a new release
heitortsergent
commented
Dec 4, 2023
| @@ -86,10 +140,22 @@ Refer to [Writers' Toolkit, Write documentation](https://grafana.com/docs/writer | |||
|
|
|||
| Once a PR is merged to the main branch, if there are any changes made to the `docs/sources` folder, the GitHub Action [`publish-technical-documentation.yml`](https://github.com/grafana/k6-docs/blob/main/.github/workflows/publish-technical-documentation.yml) will sync the changes with the grafana/website repository, and the changes will be deployed to production soon after. | |||
|
|
|||
| ### Upgrade a main release | |||
| ## Create a new release | |||
There was a problem hiding this comment.
@olegbespalov this might be helpful for the release day, let me know if this section makes sense. 🙇
oleiade
approved these changes
Dec 6, 2023
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.
What?
A little bit more cleanup work to make it easier to contribute to the docs after our migration to the Grafana website. :)
apply-patchscript, and the steps for creating a new release folder.apply-patchscript section in the CONTRIBUTING file.Checklist
Please fill in this template: