This repository has been archived by the owner on Jun 29, 2022. It is now read-only.
Simplify docs link titles #1259
Open
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
We are already nested under the quickstarts so we don't need to duplicate the heading. See the Concepts section for comparison. closes #1217
invidian
previously approved these changes
Dec 9, 2020
There was a problem hiding this comment.
Thanks a lot for another PR @kskewes! Changes looks good to me, but perhaps someone else needs to look into this PR as well, to make sure this is what we want, as @blixtra had some concerns. Maybe @iaguis?
Ran make docs in root of repository but didn't notice any side effects or changes.
I'm not sure how to locally validate how the docs render.
I was expecting I could do something like hugo server or whatever the mechanism is.
Yeah, make docs is only used right now to generate CLI reference documentation.
At the moment we have no way of locally previewing this unfortunately, though I'm sure @joaquimrocha is working on it 😉
docs/configuration-reference/components/flatcar-linux-update-operator.md
Outdated
Show resolved
Hide resolved
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
We are already nested under a heading so we can drop that heading (eg: "quickstart..." or "..... configuration reference") from the link title.
Closes #1217
Ran
make docsin root of repository but didn't notice any side effects or changes.I'm not sure how to locally validate how the docs render.
I was expecting I could do something like
hugo serveror whatever the mechanism is.