-
Notifications
You must be signed in to change notification settings - Fork 512
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
Conversation
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.' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this 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.
@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>
1666f86
to
36e9c25
Compare
@grafana/mimir-maintainers Would anyone be able to take a look at this PR, I've updated it again. |
I'm OK with the first option, will leave this for a day or two for other opinions. |
There was a problem hiding this 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.
Cheers @charleskorn! |
What this PR does
Updates the
make docs
procedure, consisting of the script and related Make scaffolding.For reviewers:
make docs
from thedocs/
directory.