Honolulu Documentation

Tracking Table

Project Name

Document Title

Document Owner

(name - use @ notation)

Current Document State (as of M1)

Choices:

  • New
  • Maintained

Activity Planned for Release

Choices:

  • Initial Publication
  • Major Update
  • Minor Update
  • No Change

Preliminary Documentation

New docs or new projects ONLY 

(enter "N/A" if not applicable, or link to gerrit if completed)

Attended Doc Hackathon 1 on <date>

(Document owner must attend at least one hackathon)

(fill in green checkmark (tick) if attended)

Attended Doc Hackathon 2 on <date>

(Document owner must attend at least one hackathon)

(fill in green checkmark (tick) if attended)

Link to Final Documentation in ReadTheDocs (stable/honolulu branch)

Reviewed by the doc project (reviewed means release related content. Such as release notes and release name were applicable)

By best effort! 

M1


M3

Post-M3RC2
HOLMESArchitectureMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-holmes-rule-management/en/honolulu/platform/architecture.html
HOLMESConfigurationMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-holmes-rule-management/en/honolulu/platform/configuration.html
HOLMESConsumed APIsMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-holmes-rule-management/en/honolulu/platform/consumedapis.html
HOLMESHuman InterfacesMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-holmes-rule-management/en/honolulu/platform/human-interfaces.html
HOLMESInstallationMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-holmes-rule-management/en/honolulu/platform/installation.html
HOLMESLogging & Diagnostic InformationMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-holmes-rule-management/en/honolulu/platform/log-and-diagnostic-info.html
HOLMESRelease NotesMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-holmes-rule-management/en/honolulu/release-notes.html#release-notes
Usecase UIRelease NotesMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-usecase-ui/en/honolulu/release-notes.html
Usecase UIUser GuideMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-usecase-ui/en/honolulu/platform/installation/user-guide/index.html
Usecase UIInstallation GuideMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-usecase-ui/en/honolulu/platform/installation/installation/index.html
VFCArchitectureMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/honolulu/platform/architecture.html
VFCOffered APIsYuanhong DengMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/honolulu/platform/APIs/index.html
VFCConsumed APIsYuanhong DengMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/honolulu/platform/consumedapis.html
VFCDeliveryMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/honolulu/platform/delivery.html
VFCLogging & Diagnostic InformationYuanhong DengMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/honolulu/platform/logging.html
VFCInstallation and User GuideYuanhong DengMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/honolulu/platform/installation/index.html
VFCRelease NotesMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/honolulu/release-notes.html
ModelingArchitectureYuanhong DengMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-modeling-etsicatalog/en/honolulu/architecture.html
ModelingOffered APIsYuanhong DengMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-modeling-etsicatalog/en/honolulu/offeredapis.html
ModelingConsumed APIsYuanhong DengMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-modeling-etsicatalog/en/honolulu/consumedapis.html
ModelingInstallationYuanhong DengMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-modeling-etsicatalog/en/honolulu/installation.html
ModelingRelease NotesYuanhong DengMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-modeling-etsicatalog/en/honolulu/release-notes.html
Modeling SubcommitteeModeling SpecsMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-modeling-modelspec/en/honolulu/ONAP%20Model%20Spec/index.html
Modeling SubcommitteeRelease NotesMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-modeling-modelspec/en/honolulu/Release-notes/release-notes.html
SORelease NotesSeshu Kumar MudigantiMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-so/en/latest/release-notes.html
SOArchitectureSeshu Kumar MudigantiMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-so/en/latest/architecture/architecture.html
OOFArchitectureMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/architecture.html
OOFOffered APIsMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/offeredapis.html
OOFConsumed APIsMaintainedMinor updatesN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/consumedapis.html
OOFLoggingMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/logging.html
OOFInstallationMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/installation.html
OOFConfigurationMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/configuration.html
OOFAdministrationMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/administration.html
OOFRelease Noteskrishna moorthyMaintainedMinor updatesN/A

https://docs.onap.org/projects/onap-optf-has/en/honolulu/sections/release-notes.html
OOFHAS - Python/Linux Distribution NotesMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-has/en/honolulu/sections/installation.html
OOFHAS - Homing Specification GuideMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-has/en/honolulu/sections/homingspecification.html
OOFHAS - Example Homing TemplatesMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-has/en/honolulu/sections/example.html
OOFOSDF - DeliveryMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/delivery.html
OOFOSDF - Human InterfacesMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/humaninterfaces.html
OOFUpgrade StrategyMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/upgradestrategy.html
OOFCMSO Service APIMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-cmso/en/honolulu/sections/offeredapis.html#cmso-service-api
OOFCMSO Optimizer APIMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-cmso/en/honolulu/sections/offeredapis.html#cmso-optimizer-api
OOFCMSO Ticket Management APIMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-cmso/en/honolulu/sections/offeredapis.html#cmso-ticket-management-api
OOFCMSO Topology APIMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-cmso/en/honolulu/sections/offeredapis.html#cmso-topology-api
OOFOOF CMSO DeliveryMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-cmso/en/honolulu/sections/delivery.html
OOFCMSO - Human InterfacesMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-cmso/en/honolulu/sections/humaninterfaces.html
OOFCMSO - GlossaryMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-cmso/en/honolulu/sections/glossary.html
OOFExample CMSO MessagesMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-optf-cmso/en/honolulu/sections/example.html
DOCProject specific release noteSofia WallinMaintainedMinor updatesN/A



DOCComposite release noteSofia WallinMaintainedMinor updatesN/A



DOCLanding pageSofia WallinMaintainedMinor updatesN/A



PolicyArchitectureMaintainedMinor updatesN/A



PolicyExposed APIsMaintainedMinor updatesN/A



PolicyRelease notesMaintainedMinor updatesN/A



CLIRElease NotesMaintainedMinot updates N/A



CLIuser guideMaintainedMinor updatesN/A



VNFSDKRElease NotesMaintainedMinot updates N/A



VNFSDKuser guideMaintainedMinor updatesN/A



CPS

Architecture

New

Initial Publication

https://gerrit.onap.org/r/c/cps/+/119410

https://docs.onap.org/projects/onap-cps/en/latest/architecture.html
CPS

Exposed API

New

Initial Publication

https://gerrit.onap.org/r/c/cps/+/119410

https://docs.onap.org/projects/onap-cps/en/latest/design.html
CPS

Consumed API

New

Initial Publication

https://gerrit.onap.org/r/c/cps/+/119410

N/A
CPS

Release Notes

New

Initial Publication

https://gerrit.onap.org/r/c/cps/+/119410

https://docs.onap.org/projects/onap-cps/en/latest/release-notes.html
CCSDKORAN-A1 User GuideMaintainedMinor updateDeveloper's Guide (latest)

https://docs.onap.org/projects/onap-ccsdk-oran/en/honolulu/guide/developer-guide.html

https://docs.onap.org/projects/onap-ccsdk-oran/en/honolulu/releasenotes/release-notes.html


CCSDKORAN-A1 Policy APINewUpdated from Guilin

https://docs.onap.org/projects/onap-ccsdk-oran/en/honolulu/offeredapis/offeredapis.html

https://docs.onap.org/projects/onap-ccsdk-oran/en/honolulu/offeredapis/pms-api.html



CCSDKCDS User GuideMaintainedMinor updateN/A



CCSDKRelease NotesDan TimoneyMaintainedMinor updateN/A



SDNCOffered APIsDan TimoneyMaintainedMinor UpdateN/A



SDNCRelease NotesMaintainedMinor UpdateN/A



DCAEArchitectureMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-dcaegen2/en/honolulu/sections/architecture.html
DCAERelease NotesMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-dcaegen2/en/honolulu/sections/release-notes.html#version-8-0-0
DCAEDCAE Service ComponentsMaintainedMinor Update on existing components + New Honolulu componentsN/A

https://docs.onap.org/projects/onap-dcaegen2/en/honolulu/sections/services/serviceindex.html
DCAEConsumed API'sMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-dcaegen2/en/honolulu/sections/consumedapis.html
DCAE Installation/Deployment GuideMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-dcaegen2/en/honolulu/sections/installation.html
DMaaP Bus ControllerArchitectureFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerDMaaP Buscontroller Release NotesFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerConfigurationFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerHuman InterfacesFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerOffered APIsFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerInstallationFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerEnvironmentFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerConsumed APIsFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerAdministrationFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerLoggingFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerDeliveryFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Bus ControllerSecurityFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterArchitectureFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterOffered APIsFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterConsumed APIsFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterDeliveryFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterLoggingFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterInstallationFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterConfigurationFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterAdministrationFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterHuman InterfacesFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Message RouterRelease NotesFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Data RouterArchitectureFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Data RouterOffered APIsFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Data RouterDeliveryFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Data RouterLoggingFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Data RouterInstallationFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Data RouterConfigurationFiachra CorcoranMaintainedNo ChangeN/A



DMaaP Data RouterDMaaP Data Router Release NotesFiachra CorcoranMaintainedNo ChangeN/A



SDCRelease NotesMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-sdc/en/honolulu/release-notes.html
SDCUser GuideMaintainedNo ChangeN/A



SDCAdministrationChrisCMaintainedNo ChangeN/A



SDCArchitectureChrisCMaintainedNo ChangeN/A



SDCConfigurationChrisCMaintainedNo ChangeN/A



SDCConsumed APIsChrisCMaintainedNo ChangeN/A



SDCOffered APIsMaintainedNo ChangeN/A



SDCDeliveryMaintainedNo ChangeN/A



SDCHuman InterfaceMaintainedNo ChangeN/A



SDCGeneric Designer IntegrationChrisCMaintainedNo Change

N/A





SDCOnboarding Package TypesChrisCMaintainedNo ChangeN/A



SDCExternal TestingMaintainedNo ChangeN/A



SDCInstallationChrisCMaintainedNo ChangeN/A



SDCLoggingChrisCMaintainedNo ChangeN/A



SDCSDC SDKsMAintainedNo ChangeN/A



SDCWorkflow DesignerMaintainedNo ChangeN/A



VVPRelease Notessteven starkMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-vvp-documentation/en/honolulu/release-notes.html
VVPUser Guidesteven starkMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-vvp-documentation/en/honolulu/validation-scripts.html
VVPHow To Contributesteven starkMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-vvp-documentation/en/honolulu/contributing.html
AAIOffered APIsMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-aai-aai-common/en/honolulu/AAI%20REST%20API%20Documentation/AAIRESTAPI.html#aai-api-definition
AAIAAI REST APIWilliam ReehilMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-aai-aai-common/en/honolulu/AAI%20REST%20API%20Documentation/AAIRESTAPI.html#aai-rest-api
AAIRelease NotesWilliam ReehilMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-aai-aai-common/en/honolulu/release-notes.html
VIDRelease NotesMaintainedMinor UpdateN/A



VIDSwagger APIMaintainedNo ChangeN/A



VIDUser GuideMaintainedNo ChangeN/A



MSBArchitectureMaintainedMinor UpdateN/A



MSBConfigurationMaintainedMinor UpdateN/A



MSBConsumed APIsJinquan NiMaintainedMinor UpdateN/A



MSBHuman InterfacesJinquan NiMaintainedMinor UpdateN/A



MSBInstallationJinquan NiMaintainedMinor UpdateN/A



MSBUser GuideMaintainedMinor UpdateN/A



EXTAPIArchitectureAdrian OSullivanMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/honolulu/architecture/architecture.html
EXTAPIOffered APIsAdrian OSullivanMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/honolulu/offeredapis/offeredapis.html
EXTAPIConsumed APIsAdrian OSullivanMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/honolulu/consumedapis/consumedapis.html
EXTAPIInstallationAdrian OSullivanMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/honolulu/installation/installation.html
EXTAPIDeveloper GuideAdrian OSullivanMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/honolulu/architecture/NBI_Developer_Guide.html
MultiCloudArchitectureBin YangMaintainedNo ChangeN/A



MultiCloudRelease NotesBin YangMaintainedMinor UpdateN/A



MultiCloudOffered APIsBin YangMaintainedMinor UpdateN/A



VNFRQTSRelease NotesMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-vnfrqts-requirements/en/honolulu/release-notes.html#release-notes
VNFRQTSGuidelinesTrevor LovettMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-vnfrqts-guidelines/en/honolulu/
VNFRQTSRequirementsTrevor LovettMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-vnfrqts-requirements/en/honolulu/
VNFRQTSTest CasesMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-vnfrqts-testcases/en/honolulu/
VNFRQTSUse CasesMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-vnfrqts-usecases/en/honolulu/

Procedure

M1

  1. Find JIRA task attached to M1 Epic for your project, if you haven't already done so.
  2. In the table above, fill in
    • project name
    • doc title,
    • doc owner (use Confluence @ notation for name, e.g., David McBride)
    • current doc state
    • activity planned for release
  3. Update status of JIRA task as Done

M3

  1. Find JIRA task attached to M2 Epic for your project, if you haven't already done so.
  2. Note that this task applies to new documents only (i.e., "New" in Current Document State column).  If this is not a new document, just enter "N/A" in the Preliminary Documentation Completed column in the table above.
  3. For new documents, at a minimum create a placeholder document (e.g., document with a title, or an outline), and commit to the repo. Add a link to the gerrit to the Preliminary Documentation column in the table above.
  4. Update the status of the JIRA task as Done.

Post M3

  1. Find the dates for the two documentation hackathons.
  2. The document owner should plan on attending at least one of the two hackathons.
  3. Enter a green checkmark in the appropriate column in the table above for the hackathon that was attended.

RC2

  1. Find JIRA task attached to RC0 Epic for your project, if you haven't already done so.
  2. Add a link to the document in ReadTheDocs in the appropriate column in the table above.
  3. Update the status of the JIRA task as Done.