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

docs: fix edit url to use main branch #300

Merged
merged 1 commit into from
May 8, 2022

Conversation

shuuji3
Copy link
Contributor

@shuuji3 shuuji3 commented May 7, 2022

Hello 🙂, this PR fixes a broken URL of the edit button on the documentation.

If you click the edit button on the documentation page, you will be redirected to a URL like this: https://github.com/argoproj-labs/argocd-autopilot/edit/master/docs/index.md. But we could not access the page since the branch name was renamed from master to main at some time.

To fix the issue, we need to explicitly specify the edit_uri option of the mkdocs, which uses the master branch by default.

I confirmed this change works on my local build by running make serve-docs command:

Screen Shot 2022-05-07 at 20 49 15

@CLAassistant
Copy link

CLAassistant commented May 7, 2022

CLA assistant check
All committers have signed the CLA.

@roi-codefresh
Copy link
Contributor

Thank you @shuuji3!

@roi-codefresh roi-codefresh merged commit dad3cf3 into argoproj-labs:main May 8, 2022
@shuuji3 shuuji3 deleted the fix-edit-url branch May 8, 2022 07:53
@shuuji3
Copy link
Contributor Author

shuuji3 commented May 8, 2022

Thanks for merging and developing the autopilot! I'm currently enjoying my first argocd-autopilot deployment. 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants