Topic | Notes | Follow-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 |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | INT-349 |
---|
|
- Logging
Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | LOG-108 |
---|
|
- Modeling Modelspec
Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | MODELING-47 |
---|
|
- OOM
Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | OOM-471 |
---|
|
- SDC
Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | SDC-713 |
---|
|
- 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 |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-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
|
Naming Standard | OOM and Modeling using 1.1.0 - is this acceptable - should we just have one naming convention? Questions to be answered whenever the TSC votes to create a named release: - where do residual improvements go for Amsterdam
- where do major new changes go for Beijing
- when do we start merging the # 2 changes to master.
We can probably accommodate different names for (#1) and/or some delay to starting #2 as long as everyone has the same view a timeline. Is there isn’t a better way use tags, eg - on the RC dates…. A Release Candidate tag is placed on every repo within a very short time by LF (< 1 hour),
- tests proceed using only tagged candidate versions
- If major tests fail, fix and goto the next RC (step 1)
- Declare a release from the last RC tags
- if / when any change is needed, a branch is created from the last RC tag
|
|
Wiki Migration | Sub Tasks for: - Setting Up ONAP
- Integrating with ONAP
- Using ONAP
- Architecture
- Documenting ONAP
- Developing ONAP
| Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-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 | - REST API
- HealthCheck API
- 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) |