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

Change API links to full urls #802

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

leslie-lau
Copy link
Contributor

Changes the Management and Bucketing API URLs to full URLs to resolve broken anchors

@@ -19,7 +19,7 @@ First, enable EdgeDB in your project’s settings.

![Project Settings]Now, let's save some data to EdgeDB.

To do this, we’ll be following the EdgeDB docs from the [Bucketing API](/bucketing-api/#tag/EdgeDB).
To do this, we’ll be following the EdgeDB docs from the [Bucketing API](https://docs.devcycle.com/bucketing-api/#tag/EdgeDB).
Copy link
Member

Choose a reason for hiding this comment

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

Won't this break testing locally?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea it does but I'm not sure how to fix these otherwise. Should we hold off?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Another way to go about these broken anchors is to use HTML. So the above would look like...

To do this, we’ll be following the EdgeDB docs from the <a href="/bucketing-api/#tag/EdgeDB">Bucketing API</a>.

The link works, docusaurus doesn't complain and you can still test locally. However, this looks like it bypasses the broken link detection which is also not great.

Copy link
Member

Choose a reason for hiding this comment

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

Do these links work locally / prod? like they look correct to me why is the broken link detection even triggering for them?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup, they all work in local and prod. I'm not sure why Docusaurus flags them, but both the API docs and CLI docs are generated by plugins so it's likely related to that.

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

Successfully merging this pull request may close these issues.

3 participants