Skip to content

Include link checker in CI#1470

Merged
krisfreedain merged 11 commits intoopensearch-project:mainfrom
dblock:link-checker
Mar 29, 2023
Merged

Include link checker in CI#1470
krisfreedain merged 11 commits intoopensearch-project:mainfrom
dblock:link-checker

Conversation

@dblock
Copy link
Member

@dblock dblock commented Mar 27, 2023

Description

Similar to opensearch-project/documentation-website#3584.

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.

Signed-off-by: dblock <dblock@amazon.com>
@dblock dblock changed the title Added link checker. Include link checker in CI Mar 27, 2023
Signed-off-by: dblock <dblock@amazon.com>
@dblock dblock force-pushed the link-checker branch 4 times, most recently from cb64e74 to 398e064 Compare March 27, 2023 18:36
dblock added 2 commits March 27, 2023 14:48
Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: dblock <dblock@amazon.com>
@dblock dblock force-pushed the link-checker branch 4 times, most recently from 73aebc5 to 47a2e21 Compare March 27, 2023 19:50
Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: dblock <dblock@amazon.com>
@dblock dblock marked this pull request as ready for review March 27, 2023 21:42
@dblock dblock requested a review from a team as a code owner March 27, 2023 21:42
@krisfreedain
Copy link
Member

@dblock - so the whole build fails if a link it broken? I don't think that's what we want to implement for the website.
Also, while this fixed a bunch of links (thank you) - it also completely deleted a partner record - also not something we want to implement on the website, I'd rather get a report to allow us to follow up on the broken links rather than deletions and failures.

@dblock
Copy link
Member Author

dblock commented Mar 28, 2023

Thanks for the review @krisfreedain!

  1. Yes, the build will fail if a link is broken. I will move this into a cron, but in the past I've seen that cause us to stop paying attention to broken links. Are you sure? Any contributor that runs into a broken link will tend to fix it if they run into that obstacle, which I think accomplishes the best outcome of links being rarely broken.
  2. I think that partner no longer exists, the website is MIA. Let me know what you want me to do with it: I could instead remove the link, or something else?

@krisfreedain
Copy link
Member

  1. Yeah, I'd love to have a weekly / monthly report on broken links if you build it out as a cron job. That would be helpful (as demonstrated by the updates you found) - but I don't want to force-break the build. When a contributor files a PR, one of us that are active maintainers should be reviewing them prior to publish. Broken links are less common at that time - but a report to catch them if they break later is actionable.
  2. Yeah - let's keep it, but I'm OK with removing the link - myself and @pajuric can follow up with them from the partner side and see what is going on. (this partner was added via PR: Request for Smart Search Tools and Weblink Technology as partners #1381 )

thanks @dblock !

Signed-off-by: dblock <dblock@amazon.com>
@dblock dblock force-pushed the link-checker branch 3 times, most recently from ba1c447 to 9f10763 Compare March 29, 2023 15:39
@dblock dblock force-pushed the link-checker branch 3 times, most recently from bfe5974 to beadebc Compare March 29, 2023 17:42
Signed-off-by: dblock <dblock@amazon.com>
dblock added 2 commits March 29, 2023 15:57
Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: dblock <dblock@amazon.com>
@dblock
Copy link
Member Author

dblock commented Mar 29, 2023

@krisfreedain

  1. Updated job to run on push (every change to main). It will auto-cut an issue if a link is broken, e.g. [AUTOCUT] Broken links dblock/project-website#3
  2. Removed partner link, kept the partner.

Copy link
Member

@krisfreedain krisfreedain left a comment

Choose a reason for hiding this comment

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

this is great - thank you @dblock

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.

[DOC] Broken links in sql ODBC docs

2 participants