Tong Mu
97b5264fcc
Migrate in-comment links of the flutter/engine repository to the flutter/flutter repository ( #166790 )
...
This PR migrates almost all in-comment links that points to the main
branch of flutter/engine repository to the flutter/flutter repository,
ensuring that such links are always up to date.
I've manually verified that all links are valid. There are a few cases
where the migration is not so trivial and I had to look up for the
updated location or line number, but I'm pretty sure the new value is
correct.
The only place that I don't know how to migrate is two links in
[Upgrading-pre-1.12-Android-projects.md](https://github.com/flutter/flutter/blob/master/docs/platforms/android/Upgrading-pre-1.12-Android-projects.md )
pointing to
`https://github.com/flutter/engine/blob/main/shell/platform/android/io/flutter/app/FlutterActivity.java `,
which I guess no longer exists.
There are still many links that point to a specific branch or revision
of the engine repo. I don't think we need to migrate these links, since
they're probably not meant to be kept up to date.
## Pre-launch Checklist
- [ ] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [ ] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [ ] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [ ] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [ ] All existing and new tests are passing.
If you need help, consider asking for advice on the #hackers-new channel
on [Discord].
<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
2025-04-10 15:58:23 +00:00
Parker Lougheed
22570daa18
Misc docs cleanup and fixes ( #155501 )
2024-09-24 20:03:08 +00:00
Kevin Chisholm
28033eabc2
[Release] Update release note location ( #151931 )
...
**TLDR:** Move the changelog, currently called ["hotfixes to the stable
channel"](https://github.com/flutter/flutter/blob/master/docs/releases/Hotfixes-to-the-Stable-Channel.md ),
to the root directory of Flutter/Flutter and rename it to CHANGELOG.md
before the Q3 release cutoff.
This PR accomplishes the following:
1. Renames 'Hotfixes-to-the-stable-channel' to CHANGELOG.md
2. Moves CHANGELOG.md to Flutter/Flutter root.
3. Update references to 'Hotfixes-to-the-stable-channel' to
CHANGELOG.md.
---
#### Background
Flutter has historically kept documentation on wiki pages in the Flutter
repository. Recently, we executed a large-scale migration of our wiki
into a `docs` folder within flutter/flutter.
#### Proposal
I propose relocating the current changelog, which is called ["hotfixes
to the stable
channel"](https://github.com/flutter/flutter/blob/master/docs/releases/Hotfixes-to-the-Stable-Channel.md ),
to the root directory of the Flutter/Flutter repository and renaming it
to CHANGELOG.md. This change aims to improve the visibility,
accessibility, and consistency of our documentation processes.
#### Benefits
1. **Unify Dart and Flutter Processes:** This move aligns Flutter’s
changelog management with Dart's practices. As the release manager for
both Dart and Flutter, this unification will streamline the processes
and ensure consistency across projects.
#### Timeline
I would like this proposal **approved or denied before the Q3 release
cutoff** so it may be available within the stable branch.
---
> [!NOTE]
> This proposal aims to improve our workflow and documentation
standards. I am open to feedback and further discussion on how we can
best implement this change.
2024-07-23 11:53:20 +07:00
Nate Wilson
a8f903223b
Fix markdown hyperlinks in the style guide ( #150071 )
...
Some of the syntax in the migrated [style guide](14df7be3f9/docs/contributing/Style-guide-for-Flutter-repo.md (lazy-programming)#145009 )
<br>
#### Current
> You may hear team members say "embrace the http://www.catb.org/jargon/html/Y/yak-shaving.html [yak
shave]!". This is an encouragement to https://www.youtube.com/watch?v=AbSehcT19u0 [take on the larger effort necessary] to perform a proper fix for a problem rather than just applying a band-aid.
#### This PR
> You may hear team members say "embrace the [yak shave](http://www.catb.org/jargon/html/Y/yak-shaving.html )!". This is an encouragement to [take on the larger effort necessary](https://www.youtube.com/watch?v=AbSehcT19u0 ) to perform a proper fix for a problem rather than just applying a band-aid.
<br>
Workarounds-for-common-issues.md: [**before**](14df7be3f9/docs/wiki_archive/Workarounds-for-common-issues.mdc8d84a71b7/docs/wiki_archive/Workarounds-for-common-issues.md
2024-06-12 18:41:10 +00:00
Kate Lovett
a6ff7123e5
Cleanup triage reports from docs/ ( #149545 )
...
Part of https://github.com/flutter/flutter/issues/145009
Meeting notes are some thing that will continue in the wiki, so they do not need to be checked in here.
2024-06-03 15:16:20 +00:00
Kate Lovett
1fbcbb73a0
[wiki migration] Leftover wiki pages and links ( #148989 )
...
This is waiting on
- https://github.com/flutter/flutter/pull/148777
- https://github.com/flutter/flutter/pull/148790
After this PR lands, there will likely be 1-2 more clean up PRs, after which the migration will be done!
---
This moves the remaining wiki pages as planned in [flutter.dev/go/migrate-flutter-wiki-spreadsheet](https://docs.google.com/spreadsheets/d/1x65189ZBdNiLRygpUYoU08pwvXD4M-Z157c6pm8deGI/edit?usp=sharing )
It also adds the team labels to the label bot for future PRs.
Changes to the content were only updating cross links, or links to refer to the main branch rather than master.
Remaining links to the wiki will be updated once all other pages have finished moving, they still work in the meantime.
Part of https://github.com/flutter/flutter/issues/145009
2024-05-28 15:12:10 +00:00
