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

Update make docs procedure and add workflow to keep it up to date #5794

Merged
merged 4 commits into from
Jan 12, 2024

Conversation

jdbaldry
Copy link
Member

What this PR does

Updates the make docs procedure, consisting of the script and related Make scaffolding.

For reviewers:

  1. Please ensure you can run make docs from the docs/ directory.
  2. Update repository access, please do one of the following:
    1. Add @grafana/docs-tooling with write access to the repository. It is a group containing only myself but would additionally include any other Doc squad tooling maintainers in the future. Any changes to this groups membership would be communicated.
    2. Add only my GitHub handle if that is easier for governance purposes.
    3. Ask me to remove the changes to CODEOWNERS and rely on my membership of the @grafana/mimir-maintainers group.

@jdbaldry jdbaldry requested review from a team as code owners August 21, 2023 07:32
@osg-grafana osg-grafana added type/docs Improvements or additions to documentation tooling labels Oct 18, 2023
docs/make-docs Outdated
@@ -478,6 +490,8 @@ POSIX_HERESTRING

echo
errr 'The build was interrupted or a build error occurred, check the previous logs for possible causes.'
note 'You might need to use Ctrl+c to end the process.'
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
note 'You might need to use Ctrl+c to end the process.'
note 'You might need to use Ctrl+C to end the process.'

For keys, use WYSIWYG. If we were to use shift, we would write Ctrl+Shift+C.

Copy link
Member Author

Choose a reason for hiding this comment

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

Makes sense, I can make this change upstream and it will get propagated to all other repositories.

Copy link
Contributor

@osg-grafana osg-grafana left a comment

Choose a reason for hiding this comment

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

Approving from a docs side with feedback; please have an engineer vet this for technical accuracy.

@jdbaldry
Copy link
Member Author

@grafana/mimir-maintainers Anyone able to give this a look?

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Copy link
Member Author

@grafana/mimir-maintainers Would anyone be able to take a look at this PR, I've updated it again.

@charleskorn
Copy link
Contributor

Update repository access, please do one of the following:

  1. Add @grafana/docs-tooling with write access to the repository. It is a group containing only myself but would additionally include any other Doc squad tooling maintainers in the future. Any changes to this groups membership would be communicated.
  2. Add only my GitHub handle if that is easier for governance purposes.
  3. Ask me to remove the changes to CODEOWNERS and rely on my membership of the @grafana/mimir-maintainers group.

I'm OK with the first option, will leave this for a day or two for other opinions.

Copy link
Contributor

@charleskorn charleskorn left a comment

Choose a reason for hiding this comment

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

LGTM.

I've given @grafana/docs-tooling write access to this repo.

@charleskorn charleskorn enabled auto-merge (squash) January 12, 2024 00:19
@jdbaldry
Copy link
Member Author

Cheers @charleskorn!

@charleskorn charleskorn merged commit 9ed731e into main Jan 12, 2024
28 checks passed
@charleskorn charleskorn deleted the jdb/2023-08-update-make-docs branch January 12, 2024 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tooling type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants