Use centralized make-docs script from Writers' Toolkit #2334
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
jdbaldry
requested review from
knylander-grafana,
joe-elliott,
annanay25,
mdisibio,
mapno,
kvrhdn and
zalegrala
as code owners
- Adds ability to build multiple projects simultaneously using, for example, `make docs PROJECTS='grafana grafana-cloud'`. - Adds `make doc-validator` which runs [`doc-validator`](https://github.com/grafana/technical-documentation/tree/main/tools/cmd/doc-validator) on all documentation. Using a centralized script will help ensure consistency in workflow across all projects. This PR incorporates some of the improvements from #2299 without introducing significant CI changes. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
jdbaldry
force-pushed
the
jdb/2023-04-use-centralized-make-docs
branch
from
1e8042f
to
97a013a
Compare
|
Honestly I'm unsure if we can give useful feedback on these changes. It seems this is part of a wider initiative, and docs.mk was copied from somewhere. Does it need to keep in sync or likely change? Wondering if it could be curled on demand or something. |
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
|
Closing in favor of #1942 |
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.
make docs PROJECTS='grafana grafana-cloud'.make doc-validatorwhich runsdoc-validatoron all documentation.Using a centralized script will help ensure consistency in workflow across all projects.
This PR incorporates some of the improvements from #2299 without introducing significant CI changes.
Signed-off-by: Jack Baldry jack.baldry@grafana.com