Skip to content

Commit

Permalink
Replace master-api with the new main-api links. (#9751)
Browse files Browse the repository at this point in the history
This is to replace remove the master-docs-flutter-dev gcp project.

Bug: flutter/flutter#133877

## Presubmit checklist

- [X] This PR doesn’t contain automatically generated corrections
(Grammarly or similar).
- [X] This PR follows the [Google Developer Documentation Style
Guidelines](https://developers.google.com/style) — for example, it
doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person).
- [X] This PR uses [semantic line
breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks)
of 80 characters or fewer.
  • Loading branch information
godofredoc authored Nov 2, 2023
1 parent dc8b876 commit efd0a45
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ social:
dart-site: https://dart.dev
news: https://news.dartlang.org
api: https://api.flutter.dev
master-api: https://master-api.flutter.dev
main-api: https://main-api.flutter.dev
pub: https://pub.dev
pub-api: https://pub.dev/documentation
pub-pkg: https://pub.dev/packages
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
{{site.alert.end}}

[api.flutter.dev]: {{site.api}}
[latest docs]: {{site.master-api}}
[latest docs]: {{site.main-api}}
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@ Seealso:

[Android 14 nonlinear font scaling]: https://developer.android.com/about/versions/14/features#non-linear-font-scaling
[Deprecate `textScaleFactor` in favor of `TextScaler`]: {{site.url}}/release/breaking-changes/deprecate-textscalefactor
[`TextScaler`]: {{site.master-api}}/flutter/painting/TextScaler-class.html
[`TextScaler`]: {{site.main-api}}/flutter/painting/TextScaler-class.html
[New font scaling system (Issue 116231)]: {{site.repo.flutter}}/issues/116231
[Implementing TextScaler for nonlinear text scaling]: {{site.repo.engine}}/pull/44907
18 changes: 9 additions & 9 deletions src/release/breaking-changes/android-predictive-back.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ In stable release: not yet

## References

{% include docs/master-api.md %}
{% include docs/main-api.md %}

API documentation:

Expand All @@ -352,14 +352,14 @@ Relevant PRs:
* [Predictive Back support for root routes][]
* [Platform channel for predictive back][]

[`PopScope`]: {{site.master-api}}/flutter/widgets/PopScope-class.html
[`NavigatorPopHandler`]: {{site.master-api}}/flutter/widgets/NavigatorPopHandler-class.html
[`PopInterface`]: {{site.master-api}}/flutter/widgets/PopInterface-class.html
[`Form.canPop`]: {{site.master-api}}/flutter/widgets/Form/canPop.html
[`Form.onPopInvoked`]: {{site.master-api}}/flutter/widgets/Form/onPopInvoked.html
[`Route.popDisposition`]: {{site.master-api}}/flutter/widgets/Route/popDisposition.html
[`ModalRoute.registerPopInterface`]: {{site.master-api}}/flutter/widgets/ModalRoute/registerPopInterface.html
[`ModalRoute.unregisterPopInterface`]: {{site.master-api}}/flutter/widgets/ModalRoute/unregisterPopInterface.html
[`PopScope`]: {{site.main-api}}/flutter/widgets/PopScope-class.html
[`NavigatorPopHandler`]: {{site.main-api}}/flutter/widgets/NavigatorPopHandler-class.html
[`PopInterface`]: {{site.main-api}}/flutter/widgets/PopInterface-class.html
[`Form.canPop`]: {{site.main-api}}/flutter/widgets/Form/canPop.html
[`Form.onPopInvoked`]: {{site.main-api}}/flutter/widgets/Form/onPopInvoked.html
[`Route.popDisposition`]: {{site.main-api}}/flutter/widgets/Route/popDisposition.html
[`ModalRoute.registerPopInterface`]: {{site.main-api}}/flutter/widgets/ModalRoute/registerPopInterface.html
[`ModalRoute.unregisterPopInterface`]: {{site.main-api}}/flutter/widgets/ModalRoute/unregisterPopInterface.html

[Issue 109513]: {{site.repo.flutter}}/issues/109513
[Predictive back support for root routes]: {{site.repo.flutter}}/pull/120385
Expand Down
10 changes: 5 additions & 5 deletions src/release/breaking-changes/deprecate-textscalefactor.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,11 +282,11 @@ Relevant PRs:


[Android 14 nonlinear font scaling]: https://developer.android.com/about/versions/14/features#non-linear-font-scaling
[`TextScaler`]: {{site.master-api}}/flutter/painting/TextScaler-class.html
[`MediaQuery.textScalerOf`]: {{site.master-api}}/flutter/widgets/MediaQuery/textScalerOf.html
[`MediaQuery.maybeTextScalerOf`]: {{site.master-api}}/flutter/widgets/MediaQuery/maybeTextScalerOf.html
[`MediaQuery.withNoTextScaling`]: {{site.master-api}}/flutter/widgets/MediaQuery/withNoTextScaling.html
[`MediaQuery.withClampedTextScaling`]: {{site.master-api}}/flutter/widgets/MediaQuery/withClampedTextScaling.html
[`TextScaler`]: {{site.main-api}}/flutter/painting/TextScaler-class.html
[`MediaQuery.textScalerOf`]: {{site.main-api}}/flutter/widgets/MediaQuery/textScalerOf.html
[`MediaQuery.maybeTextScalerOf`]: {{site.main-api}}/flutter/widgets/MediaQuery/maybeTextScalerOf.html
[`MediaQuery.withNoTextScaling`]: {{site.main-api}}/flutter/widgets/MediaQuery/withNoTextScaling.html
[`MediaQuery.withClampedTextScaling`]: {{site.main-api}}/flutter/widgets/MediaQuery/withClampedTextScaling.html

[New font scaling system (Issue 116231)]: {{site.repo.flutter}}/issues/116231
[Replaces `textScaleFactor` with `TextScaler`]: {{site.repo.flutter}}/pull/128522
Expand Down
4 changes: 2 additions & 2 deletions src/release/breaking-changes/describe-enum.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ Relevant PRs:

[`describeEnum` stable]: {{site.api}}/flutter/lib/src/foundation/describeEnum.html
[`EnumProperty` stable]: {{site.api}}/flutter/lib/src/foundation/EnumProperty.html
[`describeEnum` main]: {{site.master-api}}/flutter/lib/src/foundation/describeEnum.html
[`EnumProperty` main]: {{site.master-api}}/flutter/lib/src/foundation/describeEnum.html
[`describeEnum` main]: {{site.main-api}}/flutter/lib/src/foundation/describeEnum.html
[`EnumProperty` main]: {{site.main-api}}/flutter/lib/src/foundation/describeEnum.html

[Cleanup SemanticsFlag and SemanticsAction issue]: {{site.repo.flutter}}/issues/123346
[Deprecate `describeEnum` PR]: {{site.repo.flutter}}/pull/125016
18 changes: 9 additions & 9 deletions src/release/breaking-changes/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,11 @@ Reverted in version: xxx (OPTIONAL, delete if not used)
These links are commented out because they
cause the GitHubActions (GHA) linkcheck to fail.
Remove the comment tags once you fill this in with
real links. Only use the "master-api" include if
you link to "master-api.flutter.dev"; prefer our
real links. Only use the "main-api" include if
you link to "main-api.flutter.dev"; prefer our
stable documentation if possible.

{% include docs/master-api.md %}
{% include docs/main-api.md %}

API documentation:

Expand All @@ -173,21 +173,21 @@ Relevant PRs:
but please remove the comment tags before you commit!

If you are sharing new API that hasn't landed in
the stable channel yet, use the master channel link.
To link to docs on the master channel,
the stable channel yet, use the main channel link.
To link to docs on the main channel,
include the following note and make sure that
the URL includes the master link (as shown below).
the URL includes the main link (as shown below).

Here's an example of defining a stable (site.api) link
and a master channel (master-api) link.
and a main channel (main-api) link.

<!-- Stable channel link: -->
[`ClassName`]: {{site.api}}/flutter/[link_to_relevant_page].html

<!-- Master channel link: -->
{% include docs/master-api.md %}
{% include docs/main-api.md %}

[`ClassName`]: {{site.master-api}}/flutter/[link_to_relevant_page].html
[`ClassName`]: {{site.main-api}}/flutter/[link_to_relevant_page].html

[Issue xxxx]: {{site.repo.flutter}}/issues/[link_to_actual_issue]
[Issue yyyy]: {{site.repo.flutter}}/issues/[link_to_actual_issue]
Expand Down
2 changes: 1 addition & 1 deletion src/release/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ We do not recommend using this channel as
it is more likely to contain serious regressions.

The latest documentation for the **master** branch
is at: <https://master-api.flutter.dev>
is at: <https://main-api.flutter.dev>

### Changing channels

Expand Down
2 changes: 1 addition & 1 deletion src/release/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ and [Introducing Dart 3 alpha][].
* Global selection improvements - ChunHeng Tai (chtai)
* magnification property (who owns this? - I asked Justin)
No docs yet (other than API docs)
https://master-api.flutter.dev/flutter/material/TextField/magnifierConfiguration.html
https://main-api.flutter.dev/flutter/material/TextField/magnifierConfiguration.html
* Implementing iOS PlatformView BackdropFilter. (Blur) - Leigha and Chris Yang
https://docs.google.com/document/d/1V7Jc_RGaknrBBPPBBKB8lT7f3PKhYr8sin35MSMFAf4/edit
* Memory management updates - Zach Anderson
Expand Down
2 changes: 1 addition & 1 deletion tool/config/linkcheck-skip-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# sometimes too long for Travis, so it is simpler just to skip all site links.

https://github.com
https://master-api.flutter.dev
https://main-api.flutter.dev

# -----------------------------------------------------------------------------
# Valid external links that result in connection failures too often:
Expand Down

0 comments on commit efd0a45

Please sign in to comment.