Versions Compared

Old Version 12

changes.mady.by.user Rich Bennett

Saved on

compared with

New Version Current

changes.mady.by.user Rich Bennett

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

TopicNotesFollow-up
Release / Branching Strategy
  • Amsterdam doc project branch created and tracking updates in any other repo providing documentation  that has an Amsterdam branch. For those that did not have an Amsterdam branch, we are using head of the master branch as of ~11/24 4pm EST.
  • Project repos that still need to be tagged:
    • Integration  
      Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyINT-349
    • Logging  
      Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyLOG-108
    • Modeling Modelspec 
      Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyMODELING-47
    • OOM 
      Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyOOM-471
    • Portal 
      Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyPORTAL-149
    • SDC 
      Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keySDC-713
    • VNF Guidelines 
      Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyVNFRQTS-145
    • VNF Requirements 
      Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyVNFRQTS-146
    • VNF SDK Model 
      Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyVNFSDK-132
  • Where Amsterdam changes are expected and should be automatically published when merged, an Amsterdam branch may be created.
  • Both master and amsterdam are being published at read the docs.  The default when someone enter http://docs.onap.org is master and the the developer wiki download link currently points to master.    Should we change this?
  • Each PTL committer for the repos list in column 2, to identify the hash and create a release branch "amsterdam".
  • Sync up the doc project amsterdam branch submodule references with created amsterdam branches, 
    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyDOC-210
  •  Switch DW download link to RTD amsterdam when branches above are completed Rich Bennett   


  •  What needs to change for the latest vFW instructions? Eric Debeau
  •  Do we need something for new users (not developers) that want to understand use cases, try higher level service/policy scenarios, etc?  Eric Debeau


Wiki Migration

Sub Tasks for:

  • Setting Up ONAP
  • Integrating with ONAP
  • Using ONAP
  • Architecture
  • Documenting ONAP
  • Developing ONAP

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-179

  •  Start with (oom kubernetes,  quickstart, heat template ), set example / define a best practice for collecting/refining documentation on wiki, following a process with wiki labels, JIRA tickets, etc that keeps everyone aware of state and transition to change controlled documentation in gerrit
Structure Clean-Up
  • Developing ONAP:   Structure and Headings clean-up
New JIRA Issue
Carrier Grade
  • "Carrier Grade" usability - what does that mean for Documentation?
  • Insuring standards/consistency across projects (e.g. terminology, monitoring, clustering)
  • Usability (e.g. Designer, VNF Providers, Operations)
New JIRA Issue
APIs
  • Differentiate:
  1. REST API
  2. HealthCheck API
  3. Components API (eg Java class API)
New JIRA Issue
Glossary

Modeling team responsible

  • Definitions to RsT
  • Indexing / tagging to enable Searching

Address during Release 2

Create JIRA issue - Greg follow up

Tooling / Utilities documentation

How to:

  • Gerrit guide
  • Guidelines (Builds, etc.)
  • Utilities:  Jenkins, Conversion tools (e.g. LFPandocs)


New JIRA Issue
(LF pursuing Quarter 3, 2018)

...