Skip to content

Add github workflow to ensure that links in documentation resolve - #1542

Open
cwperks wants to merge 3 commits into
opensearch-project:mainfrom
cwperks:lychee
Open

Add github workflow to ensure that links in documentation resolve#1542
cwperks wants to merge 3 commits into
opensearch-project:mainfrom
cwperks:lychee

Conversation

@cwperks

@cwperks cwperks commented May 7, 2025

Copy link
Copy Markdown
Member

Description

This PR adds a CI Check that utilizes lychee to ensure that links in documentation resolve correctly. If any link in documentation 404s or gives back a bad response code, this CI check will fail until the faulty link is corrected.

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Craig Perkins <cwperx@amazon.com>
cwperks added 2 commits May 19, 2025 16:58
Signed-off-by: Craig Perkins <cwperx@amazon.com>
Signed-off-by: Craig Perkins <cwperx@amazon.com>
@monusingh-1
monusingh-1 enabled auto-merge (squash) August 28, 2025 07:23
Comment thread HANDBOOK.md
"
```

## Security

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Lets not remove the permissions required for running CCR plugin.

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