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 links from Security tab of repository. #1155

Merged
merged 1 commit into from
Feb 5, 2025

Conversation

TonyLovesDevOps
Copy link
Contributor

These links to the signing keys work fine when you open the security.md file from within the docs/ directory, but they 404 when you click on the Security tab in the repository. This change should fix this.

These links to the signing keys work fine when you open the `security.md` file from within the `docs/` directory, but they 404 when you click on the `Security` tab in the repository. This change should fix this.
@synfinatic
Copy link
Owner

isn't this change going to break the links for people who navigate to the page via the docs since the links are relative? https://synfinatic.github.io/aws-sso-cli/v1.17.0/security/

seems like we need to move the entire page and update mkdocs to find the new location.

@TonyLovesDevOps
Copy link
Contributor Author

Good question. Adding /docs should make it relative to the root of the repository, so it should work on different forks, etc. I don't know about the impact on mkdocs but I'd hope it would be able to figure this out.

@synfinatic
Copy link
Owner

welp, linkinspector says it's fine so who am I to argue? let's find out.

@synfinatic synfinatic merged commit ee6fef0 into synfinatic:main Feb 5, 2025
1 check passed
@synfinatic
Copy link
Owner

synfinatic commented Feb 5, 2025

Reverting. links on https://synfinatic.github.io/aws-sso-cli/develop/security/ are broken.

edit: users were directed to: https://synfinatic.github.io/docs/commit-sign-key.asc.md

@TonyLovesDevOps
Copy link
Contributor Author

Fair enough. I agree that broken links on the docs page are worse than broken links on the security tab -- anyone there should be able to figure out where to get the keys they need, like I did.

@synfinatic
Copy link
Owner

FWIW, i'm open to something that fixes the security tab. Just without the negative side effects. Feel free to open another PR if you can fix mkdocs. You should be able to test locally via make serve-docs assuming you have docker installed.

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.

2 participants