Skip to content

Conversation

@kodster28
Copy link
Collaborator

@kodster28 kodster28 commented Jan 27, 2025

Summary

When our old API docs site was using Stoplight, we had two interconnected issues that made it difficult to maintain API docs links w/in our docs.

  1. The endpoints would change names if their names were updated (lacked permanent IDs). This meant that moving something to a deprecated status would also change the endpoint URL.
  2. The site itself loaded too slowly for external link validators, which prevented us from using our existing SEO tooling to find broken links.

With the migration to a new API docs framework, these issues should be gone and we can remove this code from our repo.

Problem should now be solved by either standard SEO crawling or the work that @bllchmbrs is helping us with.

Risks

None. This only involved a scheduled GitHub action, so there should be no impact to our site.

@cloudflare-workers-and-pages
Copy link

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4c41f4a
Status: ✅  Deploy successful!
Preview URL: https://9d341776.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://remove-api-crawl-script.cloudflare-docs-7ou.pages.dev

View logs

@kodster28 kodster28 merged commit 28bbbed into production Jan 27, 2025
11 checks passed
@kodster28 kodster28 deleted the remove-api-crawl-script branch January 27, 2025 17:17
deadlypants1973 pushed a commit that referenced this pull request Jan 29, 2025
* [Chore] Remove API crawl script

* remove command from package.json
kodster28 added a commit that referenced this pull request Jan 30, 2025
* [Chore] Remove API crawl script

* remove command from package.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants