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: update docs to point to migration docs #1050

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

davidlj95
Copy link
Owner

@davidlj95 davidlj95 commented Nov 21, 2024

Issue or need

Custom metadata manager guide contains a bit of explanation about the first two deprecations. However, there are now entire pages dedicated to them.
Providers selection guide can also be referred in the migration guide about function-based providers. To checkout deprecated documentation.

Also, migration docs aren't in README.md introduction points

Proposed changes

Reference doc pages about migrations. Move information in those comments (outdated references to deprecated APIs and comment about bundle size) to the migration page.

Change admonition types to question. As that's what titles for those are right now.

Add references to providers selection guide to the function-based providers migration.

Add migration docs to README.md introduction points

Adds link to API reference to first migration (every guide contains a link at the end to the new docs)

Quick reminders

  • 🤝 I will follow Code of Conduct
  • No existing pull request already does almost same changes
  • 👁️ Contributing docs are something I've taken a look at
  • 📝 Commit messages convention has been followed
  • 💬 TSDoc comments have been added or updated indicating API visibility if API surface has changed.
  • 🧪 Tests have been added if needed. For instance, if adding new features or fixing a bug. Or removed if removing features.
  • ⚙️ API Report has been updated if API surface is altered.

Copy link
Owner Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link

codecov bot commented Nov 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (875e5fb) to head (f013203).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1050   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           97        97           
  Lines          537       537           
  Branches        64        64           
=========================================
  Hits           537       537           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

Copy link

github-actions bot commented Nov 21, 2024

📦 Bundle size (Angular v16)

Git ref: f01320336b4864beabe28a9de04357117b20c976

Module file Size Base size Difference
ngx-meta-core.mjs 3411 bytes (3.4KiB) 3411 bytes (3.4KiB) No change
ngx-meta-json-ld.mjs 193 bytes (193B) 193 bytes (193B) No change
ngx-meta-open-graph.mjs 804 bytes (804B) 804 bytes (804B) No change
ngx-meta-routing.mjs 379 bytes (379B) 379 bytes (379B) No change
ngx-meta-standard.mjs 739 bytes (739B) 739 bytes (739B) No change
ngx-meta-twitter-card.mjs 470 bytes (470B) 470 bytes (470B) No change
Total 5996 bytes (5.9KiB) 5996 bytes (5.9KiB) No change

Copy link

github-actions bot commented Nov 21, 2024

📦 Bundle size (Angular v17)

Git ref: f01320336b4864beabe28a9de04357117b20c976

Module file Size Base size Difference
ngx-meta-core.mjs 3205 bytes (3.2KiB) 3205 bytes (3.2KiB) No change
ngx-meta-json-ld.mjs 219 bytes (219B) 219 bytes (219B) No change
ngx-meta-open-graph.mjs 1033 bytes (1.1KiB) 1033 bytes (1.1KiB) No change
ngx-meta-routing.mjs 394 bytes (394B) 394 bytes (394B) No change
ngx-meta-standard.mjs 943 bytes (943B) 943 bytes (943B) No change
ngx-meta-twitter-card.mjs 539 bytes (539B) 539 bytes (539B) No change
Total 6333 bytes (6.2KiB) 6333 bytes (6.2KiB) No change

Copy link

github-actions bot commented Nov 21, 2024

📦 Bundle size (Angular v15)

Git ref: f01320336b4864beabe28a9de04357117b20c976

Module file Size Base size Difference
ngx-meta-core.mjs 3386 bytes (3.4KiB) 3386 bytes (3.4KiB) No change
ngx-meta-json-ld.mjs 198 bytes (198B) 198 bytes (198B) No change
ngx-meta-open-graph.mjs 804 bytes (804B) 804 bytes (804B) No change
ngx-meta-routing.mjs 373 bytes (373B) 373 bytes (373B) No change
ngx-meta-standard.mjs 739 bytes (739B) 739 bytes (739B) No change
ngx-meta-twitter-card.mjs 412 bytes (412B) 412 bytes (412B) No change
Total 5912 bytes (5.8KiB) 5912 bytes (5.8KiB) No change

@davidlj95 davidlj95 force-pushed the stacked/docs-update-docs-to-point-to-migration-docs branch from 1345206 to 75121bd Compare November 21, 2024 23:17
@davidlj95 davidlj95 marked this pull request as ready for review November 21, 2024 23:17
@davidlj95 davidlj95 enabled auto-merge (squash) November 21, 2024 23:17
@davidlj95 davidlj95 disabled auto-merge November 21, 2024 23:19
Copy link

github-actions bot commented Nov 21, 2024

📦 Bundle size (Angular v18)

Git ref: f01320336b4864beabe28a9de04357117b20c976

Module file Size Base size Difference
ngx-meta-core.mjs 3205 bytes (3.2KiB) 3205 bytes (3.2KiB) No change
ngx-meta-json-ld.mjs 219 bytes (219B) 219 bytes (219B) No change
ngx-meta-open-graph.mjs 1033 bytes (1.1KiB) 1033 bytes (1.1KiB) No change
ngx-meta-routing.mjs 394 bytes (394B) 394 bytes (394B) No change
ngx-meta-standard.mjs 943 bytes (943B) 943 bytes (943B) No change
ngx-meta-twitter-card.mjs 539 bytes (539B) 539 bytes (539B) No change
Total 6333 bytes (6.2KiB) 6333 bytes (6.2KiB) No change

@davidlj95 davidlj95 enabled auto-merge (squash) November 21, 2024 23:25
@davidlj95 davidlj95 merged commit 58c06d3 into main Nov 21, 2024
35 checks passed
@davidlj95 davidlj95 deleted the stacked/docs-update-docs-to-point-to-migration-docs branch November 21, 2024 23:30
Copy link

🎉 This PR is included in version 1.0.0-beta.36 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant