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.

Sign up for GitHub

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

Jump to bottom

github: Add checker for docs links #3027

Merged
merged 13 commits into from
May 26, 2024
Merged

github: Add checker for docs links #3027

merged 13 commits into from
May 26, 2024

Conversation

illume
Copy link
Contributor

@illume illume commented Mar 21, 2024 •
edited
Loading

What does this change

Check links in docs/

(Hello from Kubecon contribfest)
Untested, and I have not run it yet.

Uses htmltest to check issues.

Run htmltest locally.

hugo -s docs -d /tmp/bla
htmltest /tmp/bla

What issue does it fix

Closes #2881

Checklist

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Reviewer Checklist

  • Comment with /azp run test-porter-release if a magefile or build script was modified
  • Comment with /azp run porter-integration if it's a non-trivial PR

@schristoff
Copy link
Member

A couple things - first off thank you so much for this, I appreciate it greatly.
Please do not forget to add your name to the contributors.md :)
I am planning to merge this 🔜 - so please don't think I forgot about it. But I'm going to push to get the docs to not 404 before we do. I just need to sit down for a couple hours, with a redbull, doing find and replaces.

@kichristensen
Copy link
Contributor

@schristoff Let me know if there are anything I can do help with fixing the 404s in the docs

@schristoff schristoff mentioned this pull request May 12, 2024
Closed
11 tasks
@kichristensen kichristensen added the docs Markdown ahoy! Updates needed on porter.sh or in dev docs. label May 21, 2024
kichristensen added a commit to kichristensen/porter that referenced this pull request May 21, 2024
@kichristensen
Add trailing slash to items in the website menu
01c5080 
A missing trailing slash causes a extra redirect to the page with
a trailing slash. It also fixes some for the errors reported by the link
checker in getporter#3027.

Signed-off-by: Kim Christensen <[email protected]>
@kichristensen kichristensen mentioned this pull request May 21, 2024
Merged
4 tasks
@kichristensen
Copy link
Contributor

@illume Some of the default configuration values needs to be updated in order to remove some false positives. Is it okay if add a commit to you branch with the updated configuration?

schristoff pushed a commit that referenced this pull request May 21, 2024
@kichristensen
Add trailing slash to items in the website menu (#3125)
48cbec1 
A missing trailing slash causes a extra redirect to the page with
a trailing slash. It also fixes some for the errors reported by the link
checker in #3027.

Signed-off-by: Kim Christensen <[email protected]>
@illume
Copy link
Contributor Author

illume commented May 22, 2024

Feel free. Let me know if you need anything else? Happy to help where I can.

@kichristensen
Fix some more
bd42689 
Signed-off-by: Kim Christensen <[email protected]>
@kichristensen
Other small fixes
5866772 
Signed-off-by: Kim Christensen <[email protected]>
@kichristensen
Ignore Marketplace URL as it for some reason doesn't work correctly w…
c3523be 
…ith link checker

Signed-off-by: Kim Christensen <[email protected]>
@kichristensen
Fix last few things
dbbf26c 
Signed-off-by: Kim Christensen <[email protected]>
@kichristensen
Add Go caching in the workflow
f27d956 
Signed-off-by: Kim Christensen <[email protected]>
@kichristensen
Copy link
Contributor

The rest of the failures needs to be fixed in the operator repository and storage-migrate will be fixed after this PR is merged as a alias have been added

@kichristensen kichristensen mentioned this pull request May 25, 2024
Merged
3 tasks
@kichristensen kichristensen merged commit 525ebd2 into getporter:main May 26, 2024
36 of 37 checks passed
@illume illume deleted the docs-check-links branch May 27, 2024 07:40
@illume
Copy link
Contributor Author

illume commented May 27, 2024

🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@schristoff schristoff schristoff approved these changes

@sgettys sgettys Awaiting requested review from sgettys sgettys is a code owner

@bdegeeter bdegeeter Awaiting requested review from bdegeeter bdegeeter is a code owner

@troy0820 troy0820 Awaiting requested review from troy0820 troy0820 is a code owner

@kichristensen kichristensen Awaiting requested review from kichristensen kichristensen is a code owner

Assignees
No one assigned
Labels
docs Markdown ahoy! Updates needed on porter.sh or in dev docs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: use hugo ref/relref shortcodes for md links
3 participants
@illume @schristoff @kichristensen