Uploaded image for project: 'Magnolia Frontend Helpers'
  1. Magnolia Frontend Helpers
  2. MGNLFE-163

Update README files to point to main documentation & publish to NPM

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Major
    • 1.2.1
    • None
    • None
    • None
    • 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)

      https://docs.magnolia-cms.com/product-docs/6.2/Developing/SPA-development-and-Magnolia/Magnolia-front-end-helpers-for-SPA/Magnolia-Angular-Editor.html

      https://docs.magnolia-cms.com/product-docs/6.2/Developing/SPA-development-and-Magnolia/Magnolia-front-end-helpers-for-SPA/Magnolia-React-Editor.html

      https://docs.magnolia-cms.com/product-docs/6.2/Developing/SPA-development-and-Magnolia/Magnolia-front-end-helpers-for-SPA/Magnolia-Vue-Editor.html

       

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                bstaryga Bartosz Staryga
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoR