Skip to content
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

Fix broken "edit this page" links in Flux CLI section #3034

Merged
merged 1 commit into from
Aug 26, 2022

Conversation

snebel29
Copy link
Contributor

@snebel29 snebel29 commented Aug 25, 2022

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

$ make serve

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.

image

After that edited content/en/docs/cmd/flux.md by adding importedDoc: true under title.

---
title: "flux"
importedDoc: true
---

then copy paste the hugo server from the previous make serve run to avoid overriding my change.

$ hugo server \
                --bind 127.0.0.1 \
                --buildDrafts \
                --buildFuture \
                --disableFastRender

And observed the links related to the source page (view page source, edit this page and create child page) disappear.

image

I think this change is good to go.

Signed-off-by: Sven Nebel <nebel.sven@gmail.com>
Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Thanks @snebel29 🏅

@stefanprodan stefanprodan changed the title Fix broken "edit this page" links in Flux CLI section #2203 Fix broken "edit this page" links in Flux CLI section Aug 26, 2022
@stefanprodan stefanprodan added the area/docs Documentation related issues and pull requests label Aug 26, 2022
@stefanprodan stefanprodan merged commit 18c944d into fluxcd:main Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken "edit this page" links in Flux CLI section
2 participants