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

docs: point to "firebase.google" domain for hyperlinks in the usage section of README.md files #8814

Merged

Conversation

nilsreichardt
Copy link
Contributor

Description

As described in #8613 are linking all README.md to the archived docs. We should change this because the docs are archived and it makes the impression that the packages are not maintained anymore, when you are linking to archived docs.

This is one of the two proposals for fixing this issue (other proposal: #8813). In this proposal, we just link to the first article of the docs.

Advantages:

Disadvantages:

  • The links are sometimes a bit random because the format doesn't fit anymore. For the old docs we had in most cases a "Usage". But now we have a lot of small pages.

This PR is a proposal and should show a proof of concept for the new format. If this is a good solution, I will continue adding the links for the other packages.

Related Issues

Closes #8613

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

@nilsreichardt
Copy link
Contributor Author

nilsreichardt commented May 31, 2022

@russellwheatley Any thoughts on this proposal?

@russellwheatley russellwheatley marked this pull request as ready for review June 1, 2022 12:00
@russellwheatley russellwheatley changed the title docs: new format for the "Usage" section in the README.md files (proposal #2) docs: point to "firebase.google" domain for hyperlinks in the usage section of README.md files Jun 1, 2022
@russellwheatley russellwheatley merged commit 78006e0 into firebase:master Jun 1, 2022
@firebase firebase locked and limited conversation to collaborators Jul 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[all] Link to documentation in README.md uses still firebase.flutter.dev url instead of firebase.google.com
3 participants