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

Remove /stable/ from api doc urls #6211

Merged
merged 1 commit into from
Nov 17, 2024
Merged

Remove /stable/ from api doc urls #6211

merged 1 commit into from
Nov 17, 2024

Conversation

MaryaBelanger
Copy link
Contributor

Fixes #6210

I did a find-and-replace to remove the redirects to /stable/ ({{site.sdkInfo.channel}}), based on this note from the new api backend launch comms:

But I didn't account for the second bullet, any possible main/dev/beta redirects, will that be an issue?

I also came across this note that uses site.sdkInfo.channel as a condition...So I'm starting to think that blanket-removing all of them might not be the right move. Please advise @parlough!

@MaryaBelanger MaryaBelanger changed the title remove /stable/ from api doc urls Remove /stable/ from api doc urls Nov 15, 2024
@dart-github-bot
Copy link
Collaborator

Visit the preview URL for this PR (updated for commit e3a3042):

https://dart-dev--pr6211-api-links-xpdvz2h7.web.app

@parlough
Copy link
Member

But I didn't account for the second bullet, any possible main/dev/beta redirects, will that be an issue?

We haven't used the functionality of deploying the site with beta/dev/main versions (and corresponding api.dart.dev links) in a long long time, so I think dropping these is fine. It will also make adding new links simpler and more consistent.

Any links to docs that are not yet on stable can manually add beta or dev.

I also came across this note that uses site.sdkInfo.channel as a condition...So I'm starting to think that blanket-removing all of them might not be the right move. Please advise @parlough!

As mentioned, we haven't used the functionality of the site documenting a beta/dev version, so I think this change is fine. We might consider dropping its usage in the note in a follow-up PR too.

Copy link
Member

@parlough parlough left a comment

Choose a reason for hiding this comment

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

Thanks for fixing these links @MaryaBelanger!

@parlough parlough merged commit 8c650ca into main Nov 17, 2024
10 checks passed
@parlough parlough deleted the api-links branch November 17, 2024 05:11
@MaryaBelanger
Copy link
Contributor Author

@parlough I just did a quick check and it doesn't look like it, but can you confirm this same kind of thing doesn't need to be applied to the flutter site? I did see some links in a site-shared file ("writing for the dart and flutter websites") that use {{site.dart-api}}

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.

Problem with api docs links
3 participants