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

Determine pattern of tooling go links and create important ones #10363

Closed
parlough opened this issue Apr 4, 2024 · 2 comments
Closed

Determine pattern of tooling go links and create important ones #10363

parlough opened this issue Apr 4, 2024 · 2 comments
Assignees
Labels
e1-hours Effort: < 8 hrs infra.structure Relates to the tools that create docs.flutter.dev p1-high Major but not urgent concern: Resolve in months. Update each month. t.cli-tools Relates to flutter <tool> tools t.dev-tools Relates to DevTools and CLI

Comments

@parlough
Copy link
Member

parlough commented Apr 4, 2024

If you have destinations you currently (or would like to) link to from tooling, please comment here with the destination/topic/reason or similar. Thanks!

@parlough parlough added infra.structure Relates to the tools that create docs.flutter.dev p1-high Major but not urgent concern: Resolve in months. Update each month. e1-hours Effort: < 8 hrs t.dev-tools Relates to DevTools and CLI t.cli-tools Relates to flutter <tool> tools labels Apr 4, 2024
@parlough parlough self-assigned this Apr 5, 2024
@DanTup
Copy link
Contributor

DanTup commented Apr 9, 2024

These are the URLs I found in the Dart-Code currently (some are Dart, but since I had them I thought I'd post them for completeness):

The last one is used to power the "Open interactive sample" CodeLens feature. We get the library/classname from the analyzers Outline data (and use class, mixin or extension-type as a suffix based on the element kind, and build a matching fragment like "widgets.RestorationMixin.1" to scroll down to the embedded sample.

sfshaza2 pushed a commit that referenced this issue Jun 19, 2024
The links added here will be used from various locations that need
consistently functional links that are sometimes manually copy and
pasted. The current set includes links the `flutter` tool, DevTools, the
VS Code plugin(s), the Flutter framework, as well as some surrounding
documentation.

It's particularly important to have these links for areas relying on
fragments, as those redirects can't happen on the server side, and
developers may continue to run SDKs or tools with old links long after
their destination needs to change.

After this PR, `/go/<design-doc>` should only be used for design docs
going forward. Only one item long, top-level redirects such as
`docs.flutter.dev/<top-level>` should also be avoided from now on.

Once this lands, I will update the tools where necessary and land
documentation in the `flutter/flutter` repository that ensures this
format of link is considered.

Contributes to #10363
atsansone pushed a commit that referenced this issue Jun 20, 2024
copybara-service bot pushed a commit to dart-lang/sdk that referenced this issue Jun 20, 2024
Bug: flutter/website#10363
CoreLibraryReviewExempt: Just updating link in API doc.
Change-Id: I6c4dc17206410fa86e88b4630c8056a994e18967
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/372381
Reviewed-by: Devon Carew <[email protected]>
Commit-Queue: Devon Carew <[email protected]>
Reviewed-by: Sam Rawlins <[email protected]>
Auto-Submit: Parker Lougheed <[email protected]>
auto-submit bot pushed a commit to flutter/flutter that referenced this issue Jun 20, 2024
parlough added a commit that referenced this issue Jun 21, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this issue Jun 24, 2024
auto-submit bot pushed a commit to flutter/packages that referenced this issue Jun 25, 2024
Contributes to flutter/website#10363 by updating to the latest links and updating some links to use new `/to/` links that can be updated as needed.
gabbopalma pushed a commit to gabbopalma/packages that referenced this issue Jun 26, 2024
…tter#6963)

Contributes to flutter/website#10363 by updating to the latest links and updating some links to use new `/to/` links that can be updated as needed.
sigurdm pushed a commit to sigurdm/flutter that referenced this issue Jun 26, 2024
sigurdm pushed a commit to sigurdm/flutter that referenced this issue Jun 26, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this issue Jun 26, 2024
bill-skdnd pushed a commit to skdnd-metaspace/webview_flutter_wkwebview that referenced this issue Aug 2, 2024
Contributes to flutter/website#10363 by updating to the latest links and updating some links to use new `/to/` links that can be updated as needed.
auto-submit bot pushed a commit to flutter/flutter that referenced this issue Aug 8, 2024
The final piece of flutter/website#10363 now that most existing relevant links have been updated to use the new redirects.
@parlough
Copy link
Member Author

In the various linked PRs, I've added tooling /to/ links for links already used in the tool and framework, and with flutter/flutter@b6cd31e, https://github.com/flutter/flutter/blob/main/docs/contributing/use-reliable-links.md now has guidelines on adding and using them.

DBowen33 pushed a commit to DBowen33/flutter that referenced this issue Aug 16, 2024
…0962)

The final piece of flutter/website#10363 now that most existing relevant links have been updated to use the new redirects.
Buchimi pushed a commit to Buchimi/flutter that referenced this issue Sep 2, 2024
…0962)

The final piece of flutter/website#10363 now that most existing relevant links have been updated to use the new redirects.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e1-hours Effort: < 8 hrs infra.structure Relates to the tools that create docs.flutter.dev p1-high Major but not urgent concern: Resolve in months. Update each month. t.cli-tools Relates to flutter <tool> tools t.dev-tools Relates to DevTools and CLI
Projects
None yet
Development

No branches or pull requests

3 participants