From 7134cba7aa509a5ee7628244c52979e02807d252 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Tue, 10 Oct 2017 07:39:06 -0400 Subject: Improve templates and add references in guides See description of DOC-101 Added multipple conf.py files to test themes and multiple versions Created initial structure for references in developer architecture guide and release notes Change-Id: I7affcd1cb0258bef7cebe357a938080abe419693 Issue-ID: DOC-101 Signed-off-by: Rich Bennett --- docs/guides/onap-developer/architecture/index.rst | 115 ++++++++++++++++++++- .../how-to-use-docs/include-documentation.rst | 43 ++++++-- 2 files changed, 147 insertions(+), 11 deletions(-) (limited to 'docs/guides/onap-developer') diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst index 4c7aad10f..f7cae3858 100644 --- a/docs/guides/onap-developer/architecture/index.rst +++ b/docs/guides/onap-developer/architecture/index.rst @@ -3,15 +3,122 @@ Architecture ============ +.. note:: + Some high level groupings are introduced below with references to project/repo index. + As more information is provided by each project these references will shift lower to + to include only certain sections from each project. For example, the project architecture section. + +Models +------ + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/modeling/modelspec.git/docs/index + +User Interfaces +--------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/clamp.git/docs/index + ../../../submodules/cli.git/docs/index + ../../../submodules/sdc/jtosca.git/docs/index + ../../../submodules/sdc/sdc-distribution-client.git/docs/index + ../../../submodules/sdc/sdc-docker-base.git/docs/index + ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index + ../../../submodules/sdc/sdc-tosca.git/docs/index + ../../../submodules/sdc/sdc-workflow-designer.git/docs/index + ../../../submodules/sdc.git/docs/index + ../../../submodules/usecase-ui.git/docs/index + ../../../submodules/vid/asdcclient.git/docs/index + ../../../submodules/vid.git/docs/index + Platform Components ------------------- +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/appc/deployment.git/docs/index + ../../../submodules/appc.git/docs/index + ../../../submodules/dcaegen2.git/docs/index + ../../../submodules/holmes/engine-management.git/docs/index + ../../../submodules/holmes/rule-management.git/docs/index + ../../../submodules/policy/engine.git/docs/index + ../../../submodules/sdnc/adaptors.git/docs/index + ../../../submodules/sdnc/architecture.git/docs/index + ../../../submodules/sdnc/core.git/docs/index + ../../../submodules/sdnc/features.git/docs/index + ../../../submodules/sdnc/northbound.git/docs/index + ../../../submodules/sdnc/oam.git/docs/index + ../../../submodules/sdnc/parent.git/docs/index + ../../../submodules/sdnc/plugins.git/docs/index + ../../../submodules/so/libs.git/docs/index + ../../../submodules/so.git/docs/index + ../../../submodules/vfc/lcm.git/docs/index + ../../../submodules/vfc/nfvo/lcm.git/docs/index + +Platform Common Services +------------------------ + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/aaf/authz.git/docs/index + ../../../submodules/aai/aai-common.git/docs/index + ../../../submodules/aai/data-router.git/docs/index + ../../../submodules/aai/esr-gui.git/docs/index + ../../../submodules/aai/esr-server.git/docs/index + ../../../submodules/aai/resources.git/docs/index + ../../../submodules/aai/search-data-service.git/docs/index + ../../../submodules/aai/sparky-be.git/docs/index + ../../../submodules/aai/sparky-fe.git/docs/index + ../../../submodules/aai/traversal.git/docs/index + ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index + ../../../submodules/msb/apigateway.git/docs/index + ../../../submodules/msb/discovery.git/docs/index + ../../../submodules/msb/java-sdk.git/docs/index + ../../../submodules/msb/swagger-sdk.git/docs/index + ../../../submodules/multicloud/framework.git/docs/index + ../../../submodules/oom.git/docs/index + SDKs ---- -Data Models ------------ +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/ccsdk/dashboard.git/docs/index + ../../../submodules/ccsdk/distribution.git/docs/index + ../../../submodules/ccsdk/parent.git/docs/index + ../../../submodules/ccsdk/platform/blueprints.git/docs/index + ../../../submodules/ccsdk/platform/nbapi.git/docs/index + ../../../submodules/ccsdk/platform/plugins.git/docs/index + ../../../submodules/ccsdk/sli/adaptors.git/docs/index + ../../../submodules/ccsdk/sli/core.git/docs/index + ../../../submodules/ccsdk/sli/northbound.git/docs/index + ../../../submodules/ccsdk/sli/plugins.git/docs/index + ../../../submodules/ccsdk/storage/esaas.git/docs/index + ../../../submodules/ccsdk/storage/pgaas.git/docs/index + ../../../submodules/ccsdk/utils.git/docs/index + ../../../submodules/portal.git/docs/index + ../../../submodules/vnfsdk/model.git/docs/index + +Other +----- -Dependencies ------------- +.. toctree:: + :maxdepth: 1 + :titlesonly: + ../../../submodules/integration.git/docs/index + ../../../submodules/optf/has.git/docs/index + ../../../submodules/vnfrqts/guidelines.git/docs/index + ../../../submodules/vnfrqts/requirements.git/docs/index diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 6d970123f..aa2def9d7 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -202,19 +202,48 @@ Creating Restructured Text Templates and Examples ---------------------- -Some templates are available that capture the kinds of information -useful for different types of projects and provide simple examples of -restructured text. -You can: browse the templates below; show source to look at the Restructured -Text and Sphinx directives used; and then copy the source either from a browser window +Templates are available that capture the kinds of information +useful for different types of projects and provide some examples of +restructured text. We organize templates in the following way to: help authors +understand relationships between documents; keep the user audience context in mind when writing; +and tailor sections for different kinds of projects. + +**Sections** Represent a certain type of content. A section is **provided** in a repository, to +to describe something about the characteristics, use, capability, etc. of things in that repository. +A section may also be **referenced** from other sections and in other repositories. +The notes in the beginning of each section template provide +additional detail about what is typically covered and where there may be references to the section. + +**Collections** Are a set of sections that are typically provided for a particular type +of project, repository, guide, reference manual, etc. + +You can: browse the template *collections* and *sections* below; show source to look at the Restructured +Text and Sphinx directives used; copy the source either from a browser window or by downloading the file in raw form from -the `gerrit doc repository `_. +the `gerrit doc repository `_ and +then add them to your repository docs folder and index.rst. + + +Sections +++++++++ .. toctree:: :maxdepth: 1 :glob: - ../../../templates/**/index + ../../../templates/sections/* + + +Collections ++++++++++++ + +.. toctree:: + :maxdepth: 1 + :glob: + + ../../../templates/collections/* + + In addition to these simple templates and examples there are many open source projects (e.g. Open Daylight, Open Stack) -- cgit 1.2.3-korg