Uploaded image for project: 'eZ Publish / Platform'
  1. eZ Publish / Platform
  2. EZP-26888

Moving technical documentation on Github

    XMLWordPrintable

Details

    • Documentation Improved

    Description

      Text files + near the code + with custom CSS

      Purpose

      • Bring a useful documentation to our users (community and customers)
      • Providing collaboration possibility to our users :
        • respecting our opensource DNA,
        • providing accurate documentation,
        • providing translated documentation
      • Having a easy-to-maintain documentation
        • Quick to edit (typos)
        • Easy to add new chapters/pages in the archi information tree/organisation
      • Ease the review of the collaborative part for Doc Writers

      Scope

      1. Use Github to store the Documentation content
      2. Render in HTML this content
      3. Display this content on ezplatform.com

      Attachments

        Activity

          People

            Unassigned Unassigned
            sarah.haim-lubczanski-obsolete@ez.no Sarah Haïm-Lubczanski (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: