Uploaded image for project: 'Nuxeo Documentation'
  1. Nuxeo Documentation
  2. NXDOC-1381

Prepare doc day for LTS 2017

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Doc Management

      Description

      Like last year, we'll do a Doc Day during which the developers will review the existing documentation to give a relevancy status for LTS 2017.

      To prepare this doc day:

      1. Check that all pages have a -component label and add one for those that don't. (See the list of existing components from last year below).
        https://docs.google.com/spreadsheets/d/16R19dzuk_UUfeeT5ZzU5SKQZM1L7UnkgF0VmgVtsl0o/edit#gid=0
      2. Assign components to people (to do with Alain).
      3. Prepare a short documentation (on wiki.nuxeo.com) to explain how people should proceed to give a status on pages. Process would be something like:
        Update the Review metadata in the page frontmatter: 
        * If the content is still relevant for LTS 2016, change review date current date and make sure status is "ok".
        * If you see that the page requires small updates, please edit and update the page directly as you read it. Change review date current date and make sure status is "ok". It will take less time to everyone that to read it again and update it later.
        * If the topic is still relevant for LTS 2016 but content needs to be deeply updated, change review date current date, change status to "not-ok" or "requiresUpdates" and add a comment explaining what's wrong. Note: The comment will displayed on the page. To be defined: create a JIRA ticket?
        * If page is clearly obsolete and should not be available anymore, create a  jira ticket and start processing it once you are done with all of your assigned pages
        

      List of components from LTS 2016 doc day:

      • Architecture
      • Actions & Filters
      • Content views
      • Layouts & Widgets
      • Query & Page Provider
      • Seam / JSF
      • Search tab
      • Smart search
      • TinyMCE
      • Translations
      • URL Codec
      • User Profile
      • User Registration
      • Binary Metadata
      • Media Publishing
      • Web UI
      • Audit
      • Diff
      • Digital Signature
      • File upload
      • iOS Client
      • Login Page
      • SOAP
      • Elasticsearch
      • Security
      • Authentication
      • CAS
      • Kerberos
      • OAuth
      • OpenID
      • Token based authentication
      • WebEngine
      • Blob Manager
      • CMIS
      • Core
      • Directory
      • MongoDB
      • Publishing
      • Quotas
      • Tagging
      • VCS
      • WebDav
      • Preview
      • Aggregates
      • Collection
      • Template Rendering
      • Workflow
      • Distributions
      • Packaging
      • Shell
      • Style & CSS
      • Themes
      • Live Connect
      • Playground
      • SAML
      • Spreadsheet
      • REST API
      • Schema
      • PHP Client
      • Nuxeo Drive
      • Python Client
      • Core IO
      • CSV Importer
      • Bulk importer
      • Virtual Navigation
      • GWT
      • Runtime
      • Work Manager
      • Conversions
      • DAM
      • JavaScript Client
      • Renditions
      • Thumbnail
      • Android Connector
      • Automation
      • Java Client
      • Shibboleth
      • Elements

        Attachments

          Activity

            People

            • Assignee:
              mlumeau Manon Lumeau
              Reporter:
              mlumeau Manon Lumeau
              Participants:
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: