Fix broken "edit this page" links in Flux CLI section #3034
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.
This MR closes #2203
As described in the original issue, the fix to disable the source page related links is pretty simple by adding
importedDoc: true
within the header.It took me a while to realise where this was exactly needed, I was unable to find documentation about that option and another while to test that the change was good.
Validation procedure
I did checkout https://github.com/fluxcd/website then I ran
Which generated the site and served it on http://localhost:1313 then navigated to http://localhost:1313/docs/cmd/flux/ and observed the "Edit this page" along with the other source page links.
After that edited
content/en/docs/cmd/flux.md
by addingimportedDoc: true
under title.then copy paste the
hugo server
from the previousmake serve
run to avoid overriding my change.And observed the links related to the source page (view page source, edit this page and create child page) disappear.
I think this change is good to go.