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

Hyperlint Automation: Broken Link Fixes #20248

Open
wants to merge 2 commits into
base: production
Choose a base branch
from

Conversation

hyperlint-ai[bot]
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot commented Feb 25, 2025

Broken Link Fix Proposal(s)

The goal of this pull request is to fix broken links in the documentation.

Proposing changes to the following files:

to edit this branch locally, run:

git checkout hyperlint/scan/broken-link/7a59a41

🗣️Leave us feedback

🪄 Experimental Hyperlint Feature - Read more 👇

This pull request is part of a series of Hyperlint Automations to ease the burden of maintaining documentation.

We'll be introducing this automation, and others, over the coming months. These automations will always open pull requests(or issues) prior to making changes.

If this is not the change you want, please close this pull request and let us know what you'd like to see.

⚠️ Important Note:
This feature may introduce erroneous changes (although we work hard to make sure that doesn't happen). Please review the changes before merging.

❌ Limitations:
At this time, Hyperlint can't respond to pull requests or issues.

📩 Need Help?
Please reach out to support with any requests, questions, or concerns.

@hyperlint-ai hyperlint-ai bot requested review from patriciasantaana and a team as code owners February 25, 2025 08:12
@@ -18,7 +18,7 @@ Monitor the health of your <GlossaryTooltip term="API endpoint">API endpoints</G

This will add the specified endpoints to your list of managed endpoints. You can view your list of saved endpoints in the **Endpoint Management** page.

Cloudflare will start collecting [performance data](/api-shield/management-and-monitoring/#endpoint-performance-analysis) on your endpoint when you save an endpoint.
Cloudflare will start collecting [performance data](/api-shield/management-and-monitoring/#endpoint-analysis) on your endpoint when you save an endpoint.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This page: https://developers.cloudflare.com/api-shield/security/api-discovery/
has a broken internal link to: https://developers.cloudflare.com/api-shield/management-and-monitoring/.
The fragment endpoint-performance-analysis does not exist.

By looking at the page: https://developers.cloudflare.com/api-shield/management-and-monitoring/
The best fragment to use seems to be: #endpoint-analysis

@@ -51,7 +51,7 @@ API Shield first catalogs your discovered API endpoints in an email inbox-style

You should save all discovered API endpoints to Endpoint Management while ignoring any potential false positives in the API Discovery results by selecting **Save** or **Ignore** on each line. Alternatively, you can bulk-select endpoints to save or ignore. You can get started with saving endpoints by saving all endpoints with a variable. Search for `var1` in the search box and add all the resulting endpoints. You can examine endpoints without path variables for accuracy later on.

By adding endpoints to Endpoint Management, you will unlock further [security](/api-shield/security/), [visibility](/api-shield/management-and-monitoring/#endpoint-performance-analysis), and [management](/api-shield/management-and-monitoring/) features of the platform. Endpoint Management monitors the health of your API endpoints by saving, updating, and monitoring performance metrics.
By adding endpoints to Endpoint Management, you will unlock further [security](/api-shield/security/), [visibility](/api-shield/management-and-monitoring/#endpoint-analysis), and [management](/api-shield/management-and-monitoring/) features of the platform. Endpoint Management monitors the health of your API endpoints by saving, updating, and monitoring performance metrics.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This page: https://developers.cloudflare.com/api-shield/security/api-discovery/
has a broken internal link to: https://developers.cloudflare.com/api-shield/management-and-monitoring/.
The fragment endpoint-performance-analysis does not exist.

By looking at the page: https://developers.cloudflare.com/api-shield/management-and-monitoring/
The best fragment to use seems to be: #endpoint-analysis

Copy link
Contributor

Howdy and thanks for contributing to our repo. We review new, external PRs within 2 weeks. If it's been longer than then without any movement, tag the PR Assignees in a comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant