Versions Compared

Old Version 1

changes.mady.by.user Sofia Wallin

Saved on

compared with

New Version Current

changes.mady.by.user Andreas Geißler

Saved on

Key

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

...

May 14th - Virtual Event

Location - Virtual partcitation

This event will be be a virtual hacking session focusing on the Dublin Release. The call with be open throughout the day of Wednesday 17th. 

...

  • On-going Docs JIRA tickets
  • Project documentation for the Dublin release
    • HowTo Start with ONAP
    • HowTo Learn ONAP using Postman API collections
    • ONAP overview description
  • Learn more about how to work with documentation
  • Documentation improvements 
  • Documentation templates
  • Documentation and use-case articulation: how to document use-cases
  • Documentation and architecture articulation
  • Documentation and security (@Pawel Pawlak)
  • Documentation and modeling to produce a common glossary
  • Move (and mark/delete) documents from Wiki to ReadTheDocs (e.g. in UserGuide)
  • add more... 
  • Dublin Documentation Review


Creation of the user story to cover User Guide for Service DesignUpdate OOM Quick Install Guide for
NameTopic/taskOutcomeProvide RST file for Pre-Onboarding, Resource OnboardingRST files from wiki
Eric DebeauProvide RST file for VF Creation and Testing, Control Loop Design

RST files from wiki

http://84.39.48.40/ for VF Creation...

Provide RST description for BBS use-case

New RST file

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-431

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-432

Available on reasthedocs: https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html

Walking through all tickets assigned the Dublin Release (fixVersion = "Dublin Release" AND labels = Documentation AND status = Open)Following up with all projects the status of the tickets planned for the release

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-434

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-410

Changes made locally with great output. Some modifications needed before added to master and docs.onap.org

Clarify API documentation guide and explain the file location

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-426

Changes merged https://gerrit.onap.org/r/#/c/85606/

INFO

Quick check/test

There could be some format errors in the converted file which needs manually modification.

You can use an online editor for checking the output of the rst file or finding errors.

  • open the website http://rst.ninjs.org/
  • type the input in the left column or copy your rst file content into it
  • wait a few seconds, and the output would be shown in the right column
  • you can check the output (as well as warnings) in the right column
Add a "Release Documentation" reference from from wiki.onap.org main page
Jira Legacy
serverSystem Jira

Andreas Geißler
Thomas Kulik

Work of a proposal for the target content structure for ReadTheDocs,
possibly more detailed substructure for User Guide (based on Proposed Structure of Guides)		Structural proposal (e.g. Mindmap, Excel) for further discussion and implementation

Andreas Geißler

How to verify DOC pages with projects ? 
If content of DOC pages need review by ONAP projects, should there be a
"Pairewise Testing" between DOC and other projects (Integration Weather Board for Dublin Release) ?

Proposal for El Alto

Andreas Geißler

Clear Status about Wiki2RST migration of SDC Workflow Designer (https://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/workflow.html)

and DCAE-DS (https://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/dcaedesigner.html),
as well as update of "Human Interfaces" (https://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/humaninterfaces.html)


Eric Debeau

Evaluate existing rmaining JIRA issues related to documentation

Corrected DOC-426, DCAEGEN2-1049


Sofia Wallin

Open Jira tickets for the Doc project - 

Jira Legacy
serverSystem Jira
jqlQueryproject = DOC AND fixVersion = "Dublin Release" AND status = Open
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyOOM-1786

Changes submitted https://gerrit.onap.org/r/#/c/85611/


Update Dmaap API with Swagger Sofia Wallin

Open Jira tickets for all (including doc project) - 

Jira Legacy
key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverSystem Jiracolumns
jqlQuerylabels = Documentation AND fixVersion = "Dublin Release"
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDMAAP-922


Changes merged

Eric Debeau

Creation of Dublin Documentation Review


Sofia WallinDublin updates https://gerrit.onap.org/r/#/c/85622/

Eric Debeau presented the Postman collection available within the integration project: https://git.onap.org/integration/tree/test/postman

Dmaap project will provide collection

Documentation to explain how to use these API and where to find them

 made some updates on Control Loop Design align the page with current behavour (not finished yet)87650/



















Date and Time

Time zoneDateTimeParticipants
CETApril 17th09:00-16:00

Eric Debeau


EDTApril 17th09:00-16:00


PSTApril 17th06:00-09:00


Logistics:

TBA