[MGNLFE-163] Update README files to point to main documentation & publish to NPM Created: 26/Jan/22 Updated: 31/Jan/22 Resolved: 27/Jan/22 |
|
| Status: | Closed |
| Project: | Magnolia Frontend Helpers |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 1.2.1 |
| Type: | Task | Priority: | Major |
| Reporter: | Christopher Zimmermann | Assignee: | Bartosz Staryga |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||
| Template: |
|
||||||||
| Acceptance criteria: |
Empty
|
||||||||
| Task DoR: |
Empty
|
||||||||
| Epic Link: | SPA Editor Backlog | ||||||||
| Sprint: | DevX 2 | ||||||||
| Description |
|
We have created pages on docs.magnolia-cms.com for each of the three libraries. To benefit from this and to avoid confusion, the documentation notes in the README files should be removed and replaced with a link to each of the three pages in the product docs. For the change to the README to showup on npmjs.org it is probably required to publish a new version to NPM. It is fine to do this even if there is no code change. the Changelogs can simply state that the README was updated. Here is a PR prepared for changes to the READMEs of the Frontend Libraries https://git.magnolia-cms.com/projects/MODULES/repos/frontend-helpers/pull-requests/93/overview
These are the changes to the documentation: (already live)
|