Docs: Tidy up docs-related make targets #5167
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
Signed-off-by: Matej Gera <matejgera@gmail.com>
Signed-off-by: Matej Gera <matejgera@gmail.com>
saswatamcode
previously approved these changes
Feb 19, 2022
squat
reviewed
Feb 19, 2022
.github/workflows/docs.yaml
Outdated
| @@ -28,6 +28,6 @@ jobs: | |||
| key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} | |||
|
|
|||
| - name: Check docs | |||
| run: make check-docs | |||
| run: make docs | |||
There was a problem hiding this comment.
I'm a bit worried about this name change because it seems inconsistent. I think that check-* is more in line with our other make targets, for example the one below, which are designed to exit non-zero when something is wrong
There was a problem hiding this comment.
You are right, this does not fit nicely with other targets. I changed this to:
- Have
docstarget correctly generate and format the docs, including white noise handling - Keep
check-docsas a target to check against discrepancies and exiting with error if some are found
Signed-off-by: Matej Gera <matejgera@gmail.com>
matej-g
force-pushed
the
make-docs-tidy-up
branch
from
96ea922
to
5ab9133
Compare
Nicholaswang
pushed a commit
to Nicholaswang/thanos
that referenced
this pull request
Mar 6, 2022
* Tidy up doc targets Signed-off-by: Matej Gera <matejgera@gmail.com> * Fix CHANGELOG formatting Signed-off-by: Matej Gera <matejgera@gmail.com> * Adjust Make targets after feedback Signed-off-by: Matej Gera <matejgera@gmail.com> Signed-off-by: Nicholaswang <wzhever@gmail.com>
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.
Changes
Make targets to check and / or generate docs can be confusing since:
check-docswhich however also generates and formats docsdocstarget, which generates docs but this target is unused at the momentThe suggested way to improve this is:
docstarget generate and format docs correctly, including removing white noise.check-docstarget check generated docs against discrepancies in formatting, links and white noise.Also fixes CHANGELOG formatting issue that is currently in
main.Verification
Ran the targets locally.