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 links in docs #8

Merged
merged 9 commits into from
Nov 22, 2024
Merged

Conversation

colinodell
Copy link
Contributor

@colinodell colinodell commented Nov 15, 2024

💸 TL;DR

Updates links that pointed to non-public resources

📜 Details

After attending yesterday's (awesome) KubeCon session about this library, I started combing through the docs but kept hitting broken or private links. I've therefore attempted to update those links in this PR to the best location I could determine.

Please double-check my changes here (especially in the sdk-fsm-reconciler.md file) since I haven't actually used this library yet and don't want to mislead other developers by pointing to the wrong places! 😅

🧪 Testing Steps / Validation

I manually clicked the updated links to ensure they loaded?

✅ Checks

  • CI tests (if present) are passing
  • Adheres to code style for repo
  • Contributor License Agreement (CLA) completed if not a Reddit employee

@colinodell colinodell requested a review from a team as a code owner November 15, 2024 15:16
@harveyxia harveyxia requested review from harveyxia and removed request for karanthukral November 21, 2024 21:06
Copy link
Collaborator

@harveyxia harveyxia left a comment

Choose a reason for hiding this comment

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

(Karan's OOO this week so I'll take over the review) Just one minor tweak, otherwise LGTM. Thanks for these fixes!

docs/sdk-claim-claimed-reconcilers.md Outdated Show resolved Hide resolved
docs/sdk-finalizers.md Outdated Show resolved Hide resolved
@harveyxia
Copy link
Collaborator

harveyxia commented Nov 21, 2024

I'm fixing CI for forked PRs here, #9 (Github Actions doesn't allow usage of repo secrets for CI running on forked PRs, but since all dependencies are open sourced now we can fully remove this configuration)

Update against main and we can rerun CI

@colinodell
Copy link
Contributor Author

Thanks for the review! I've applied the suggestions and updated against main.

Copy link
Collaborator

@harveyxia harveyxia left a comment

Choose a reason for hiding this comment

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

Thanks again for this contribution

@harveyxia harveyxia merged commit 37ff145 into reddit:main Nov 22, 2024
1 check passed
@colinodell colinodell deleted the fix-broken-links branch November 22, 2024 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants