fix: Update docs for a final publish before we move this package. #2744
Conversation
✅ Deploy Preview for paragon-openedx ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
README.md
Outdated
| @@ -1,5 +1,10 @@ | |||
| # Paragon | |||
|
|
|||
| ## Warning: Package Moved | |||
|
|
|||
| This package will no longer receive updates and the latest version can be found | |||
There was a problem hiding this comment.
[suggestion] At first glance, the way I read this was that Paragon itself will no longer be receiving updates, not just that older @edx/paragon NPM package won't be receiving further updates.
Perhaps making "This package" more explicit by mentioning the old package name @edx/paragon instead as well as explicitly mentioning @openedx/paragon instead of just the URL to the package (i.e., non-zero effort to parse the package name from the URL):
While the Paragon design system will continue to receive updates, these updates will no longer be published at the
@edx/paragonNPM package. Instead, the latest versions can be found with@openedx/paragoninstead.
There was a problem hiding this comment.
I like that suggested rewording!
There was a problem hiding this comment.
Yea, me too, I'll update it!
README.md
Outdated
| ## Warning: Package Moved | ||
|
|
||
| This package will no longer receive updates and the latest version can be found | ||
| at https://www.npmjs.com/package/@openedx/paragon |
There was a problem hiding this comment.
[clarification] Visiting this link brings me to a login screen. I don't think we should merge this until the NPM url for @openedx/paragon is broadly available to unauthenticated users.
There was a problem hiding this comment.
@adamstankiewicz the URL breaks because we haven't published it to the new scope yet, that will be in a follow up PR that will land right after this one so the time when this URL is unavailable will be a few minutes at most.
There was a problem hiding this comment.
Thanks for the added context!
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2744 +/- ##
=======================================
Coverage 92.82% 92.82%
=======================================
Files 235 235
Lines 4237 4237
Branches 1029 1029
=======================================
Hits 3933 3933
Misses 300 300
Partials 4 4 ☔ View full report in Codecov by Sentry. |
feanil
force-pushed
the
feanil/pre_move
branch
from
bc7de29 to
0d32ffb
Compare
feanil
force-pushed
the
feanil/pre_move
branch
from
0d32ffb to
22dd0c4
Compare
|
🎉 This PR is included in version 21.5.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 22.0.0-alpha.15 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This is a part of openedx/axim-engineering#23