Page tree
Skip to end of metadata
Go to start of metadata

Milestone 6 - Preliminary Documentation

Project Name Status (Active / Inactive)

Milestone 6 (preliminary)

(yes/no - link)

   

Directory Structure

(all)

Installation Instructions

(Installer)

Configuration Guide

(Feature)

User Guide

(Feature)

Scenario Description

(Scenario owner)

Please list scenarios

Developer Guide

(test)

Release Notes

(all)

Doctor Active

yes

https://git.opnfv.org/doctor/tree/docs

n/a

yes

https://git.opnfv.org/doctor/tree/docs/release/configguide

yes

https://git.opnfv.org/doctor/tree/docs/release/userguide

n/a

https://git.opnfv.org/doctor/tree/docs/development/overview

https://git.opnfv.org/doctor/tree/docs/development/requirements/(this is output of requirement study and may not relevant to be filed as part of OPNFV release)

https://git.opnfv.org/doctor/tree/docs/release/release-notes
Calipso Active

yes

https://git.opnfv.org/calipso/tree/docs

yes

https://git.opnfv.org/calipso/tree/docs/release/install-guide.rst

yes

https://git.opnfv.org/calipso/tree/docs/release/admin-guide.rst

yes

https://git.opnfv.org/calipso/tree/docs/release/quickstart-guide.rst

n/a

yes

https://git.opnfv.org/calipso/tree/docs/release/developer-guide.rst

yes

https://git.opnfv.org/calipso/tree/docs/release/about.rst

Auto Active

yes

https://git.opnfv.org/auto/tree/docs

n/a

yes

https://git.opnfv.org/auto/tree/docs/release/configguide

yes

https://git.opnfv.org/auto/tree/docs/release/userguide

n/a n/a https://git.opnfv.org/auto/tree/docs/release/release-notes
Stor4NFV Active

yes

https://git.opnfv.org/stor4nfv/tree/docs

n/a

n/a


yes

https://git.opnfv.org/stor4nfv/tree/docs/release/userguide

https://git.opnfv.org/stor4nfv/tree/docs/release/scenarios n/a https://git.opnfv.org/stor4nfv/tree/docs/release/release-notes
availability Active https://git.opnfv.org/availability/tree/docs N/A


https://git.opnfv.org/availability/tree/docs/development/overview
edgecloud Active https://git.opnfv.org/edgecloud/tree/



https://git.opnfv.org/edgecloud/tree/docs/development/requirements
IPv6 Active https://git.opnfv.org/ipv6/tree/docs https://git.opnfv.org/ipv6/tree/docs/release/installation https://git.opnfv.org/ipv6/tree/docs/release/configguide

https://git.opnfv.org/ipv6/tree/docs/release/userguide

N/A N/A https://git.opnfv.org/ipv6/tree/docs/release/release-notes
OVN4NFV Active

yes

https://git.opnfv.org/ovn4nfv/tree/?h=stable/gambia

https://git.opnfv.org/ovn4nfv/tree/docs/development/openstack-networking-ovn.rst?h=stable/gambia

https://git.opnfv.org/ovn4nfv/tree/docs/release/configuration-guide.rst?h=stable/gambia

https://git.opnfv.org/ovn4nfv/tree/docs/development/ovn-sfc-openstack.rst?h=stable/gambia

https://git.opnfv.org/ovn4nfv/tree/docs/testing/testing-notes.rst?h=stable/gambia

N/A N/A https://git.opnfv.org/ovn4nfv/tree/docs/release/release-notes/release-notes.rst?h=stable/gambia
Promise Active https://git.opnfv.org/promise/tree/docs n/a n/a n/a
(transition to OpenStack Blazar)
n/a n/a https://git.opnfv.org/promise/tree/docs/release/release-notes
samplevnf Active

yes

https://git.opnfv.org/samplevnf/tree/docs

n/a n/a

yes

https://git.opnfv.org/samplevnf/tree/docs/testing/user/userguide

n/a n/a https://git.opnfv.org/samplevnf/tree/docs/release/release-notes
Container4NFV Active https://git.opnfv.org/container4nfv/tree/docs N/A https://git.opnfv.org/container4nfv/tree/docs/release/userguide https://git.opnfv.org/container4nfv/tree/docs/release/userguide https://git.opnfv.org/container4nfv/tree/docs/release/userguide/scenario.rst N/A https://git.opnfv.org/container4nfv/tree/docs/release/release-notes
SFC Active https://git.opnfv.org/sfc/tree/docs N/A https://git.opnfv.org/sfc/tree/docs/release/configguide/feature.configuration.rst https://git.opnfv.org/sfc/tree/docs/release/userguide/feature.userguide.rst https://git.opnfv.org/sfc/tree/docs/release/scenarios/ n/a https://git.opnfv.org/sfc/tree/docs/release/release-notes/releasenotes.rst
SDNVPN Active yes https://git.opnfv.org/sdnvpn/tree/docs https://git.opnfv.org/sdnvpn/tree/docs/release/installation no

https://git.opnfv.org/sdnvpn/tree/docs/release/userguide

https://git.opnfv.org/sdnvpn/tree/docs/release/scenarios/os-odl-bgpvpn n/a https://git.opnfv.org/sdnvpn/tree/docs/release/release-notes
Bottlenecks Active https://git.opnfv.org/bottlenecks/tree/docs N/A N/A https://git.opnfv.org/bottlenecks/tree/docs/testing/user/userguide N/A https://git.opnfv.org/bottlenecks/tree/docs/testing/developer/devguide https://git.opnfv.org/bottlenecks/tree/docs/release/release-notes
Fuel Active https://git.opnfv.org/fuel/tree/docs https://git.opnfv.org/fuel/tree/docs/release/installation N/A https://git.opnfv.org/fuel/tree/docs/release/userguide https://git.opnfv.org/fuel/tree/docs/release/scenarios N/A https://git.opnfv.org/fuel/tree/docs/release/release-notes
Armband Active https://git.opnfv.org/armband/tree/docs https://git.opnfv.org/armband/tree/docs/release/installation N/A https://git.opnfv.org/armband/tree/docs/release/userguide N/A N/A https://git.opnfv.org/armband/tree/docs/release/release-notes
Functest Active https://git.opnfv.org/functest/tree/docs?h=stable/gambia N/A https://opnfv-functest.readthedocs.io/en/latest/testing/user/configguide/index.html https://opnfv-functest.readthedocs.io/en/latest/testing/user/userguide/index.html N/A https://opnfv-functest.readthedocs.io/en/latest/testing/developer/devguide/index.html https://opnfv-functest.readthedocs.io/en/latest/release/release-notes/index.html
Samplevnf Actve https://git.opnfv.org/samplevnf/tree/docs?h=stable/gambia N/A N/A https://git.opnfv.org/samplevnf/tree/docs/release/userguide N/A N/A https://git.opnfv.org/samplevnf/tree/docs/release/release-notes?h=stable/gambia
Vswitchperf Active https://git.opnfv.org/vswitchperf/tree/docs?h=stable/gambia N/A https://git.opnfv.org/vswitchperf/tree/docs/testing/user/configguide https://git.opnfv.org/vswitchperf/tree/docs/testing/user/userguide N/A https://git.opnfv.org/vswitchperf/tree/docs/testing/developer/devguide https://git.opnfv.org/vswitchperf/tree/docs/release/release-notes

Milestone 9 - Final Documentation

Project Name

Status (Active / Inactive)

Milestone 9 (final)

(yes/no - link)

   

Directory Structure

(all)

Installation Instructions

(Installer)

Configuration Guide

(Feature)

User Guide

(Feature)

Scenario Description

(Scenario owner)

Please list scenarios

Developer Guide

(test)

Release Notes

(all)

Apex Active https://git.opnfv.org/apex/tree/docs?h=stable/gambia https://git.opnfv.org/apex/tree/docs/release/installation/index.rst?h=stable/gambia N/A N/A https://git.opnfv.org/apex/tree/docs/release/scenarios?h=stable/gambia N/A https://git.opnfv.org/apex/tree/docs/release/release-notes/release-notes.rst?h=stable/gambia
Calipso Active

yes

https://git.opnfv.org/calipso/tree/docs/release/quickstart-guide.rst

yes

https://git.opnfv.org/calipso/tree/docs/release/install-guide.rst

yes

https://git.opnfv.org/calipso/tree/docs/release/admin-guide.rst

yes

https://git.opnfv.org/calipso/tree/docs/release/quickstart-guide.rst

N/A

yes

https://git.opnfv.org/calipso/tree/docs/release/developer-guide.rst

yes

https://git.opnfv.org/calipso/tree/docs/release/about.rst

 Functest  Active https://git.opnfv.org/functest/tree/docs?h=stable/gambia  N/A https://functest.readthedocs.io/projects/configguide/en/stable-gambia/ https://functest.readthedocs.io/projects/userguide/en/stable-gambia/  N/A https://functest.readthedocs.io/projects/devguide/en/stable-gambia/  https://functest.readthedocs.io/projects/releasenotes/en/stable-gambia/
 Stor4NFV  Active https://git.opnfv.org/stor4nfv/tree/docs  no  no  https://git.opnfv.org/stor4nfv/tree/docs/release/userguide?h=stable/gambia  https://git.opnfv.org/stor4nfv/tree/docs/release/scenarios?h=stable/gambia  n/a  https://git.opnfv.org/stor4nfv/tree/docs/release/release-notes
 Promise Active https://git.opnfv.org/promise/tree/docs  N/A https://git.opnfv.org/promise/tree/docs/release/configguide  N/A  N/A  N/A  https://git.opnfv.org/promise/tree/docs/release/release-notes
Doctor Active

yes

https://git.opnfv.org/doctor/tree/docs?h=stable/gambia

N/A

yes

https://git.opnfv.org/doctor/tree/docs/release/configguide?h=stable/gambia

yes

https://git.opnfv.org/doctor/tree/docs/release/userguide?h=stable/gambia

 N/A

https://git.opnfv.org/doctor/tree/docs/development/overview?h=stable/gambia

https://git.opnfv.org/doctor/tree/docs/development/requirements/?h=stable/gambia

(this is output of requirement study and may not relevant to be filed as part of OPNFV release)

https://git.opnfv.org/doctor/tree/docs/release/release-notes?h=stable/gambia
Functest Active https://git.opnfv.org/functest/tree/docs?h=stable/gambia N/A https://opnfv-functest.readthedocs.io/en/latest/testing/user/configguide/index.html https://opnfv-functest.readthedocs.io/en/latest/testing/user/userguide/index.html N/A https://opnfv-functest.readthedocs.io/en/latest/testing/developer/devguide/index.html https://opnfv-functest.readthedocs.io/en/latest/release/release-notes/index.html
IPv6 Active https://git.opnfv.org/ipv6/tree/docs https://docs.opnfv.org/en/stable-gambia/submodules/ipv6/docs/release/installation/index.html https://docs.opnfv.org/en/stable-gambia/submodules/ipv6/docs/release/configguide/index.html https://docs.opnfv.org/en/stable-gambia/submodules/ipv6/docs/release/userguide/index.html N/A N/A https://docs.opnfv.org/en/stable-gambia/submodules/ipv6/docs/release/release-notes/release-notes.html
Armband Active https://git.opnfv.org/armband/tree/docs?h=stable/gambia https://opnfv-armband.readthedocs.io/en/stable-gambia/release/installation/installation.instruction.html N/A https://opnfv-armband.readthedocs.io/en/stable-gambia/release/userguide/index.html N/A N/A https://opnfv-armband.readthedocs.io/en/stable-gambia/release/release-notes/index.html
Fuel Active https://git.opnfv.org/fuel/tree/docs?h=stable/gambia https://opnfv-fuel.readthedocs.io/en/stable-gambia/release/installation/index.html N/A https://opnfv-fuel.readthedocs.io/en/stable-gambia/release/userguide/index.html https://opnfv-fuel.readthedocs.io/en/stable-gambia/release/scenarios/index.html N/A https://opnfv-fuel.readthedocs.io/en/stable-gambia/release/release-notes/index.html
SDNVPN Active

yes

https://git.opnfv.org/sdnvpn/tree/docs?h=stable/gambia

https://git.opnfv.org/sdnvpn/tree/docs/release/installation/index.rst?h=stable/gambia https://git.opnfv.org/sdnvpn/tree/docs/release/configguide?h=stable/gambia https://git.opnfv.org/sdnvpn/tree/docs/release/userguide/feature.userguide.rst?h=stable/gambia https://git.opnfv.org/sdnvpn/tree/docs/release/scenarios/os-odl-bgpvpn/scenario.description.rst?h=stable/gambia N/A https://git.opnfv.org/sdnvpn/tree/docs/release/release-notes/release-notes.rst?h=stable/gambia
Container4NFV Active https://git.opnfv.org/container4nfv/tree/docs N/A https://git.opnfv.org/container4nfv/tree/docs/release/userguide https://git.opnfv.org/container4nfv/tree/docs/release/userguide https://git.opnfv.org/container4nfv/tree/docs/release/userguide/scenario.rst N/A https://git.opnfv.org/container4nfv/tree/docs/release/release-notes
Clover Active https://git.opnfv.org/clover/tree/docs?h=stable/gambia N/A https://git.opnfv.org/clover/tree/docs/release/configguide?h=stable/gambia https://git.opnfv.org/clover/tree/docs/release/userguide?h=stable/gambia N/A N/A https://git.opnfv.org/clover/tree/docs/release/release-notes?h=stable/gambia
availability Active https://git.opnfv.org/availability/tree/docs/development/overview?h=stable/gambia N/A N/A N/A N/A https://git.opnfv.org/availability/tree/docs/development/overview/HA_Analysis-Gambia.rst?h=stable/gambia N/A
Edge Active https://git.opnfv.org/edgecloud/tree/docs?h=stable/gambia&id=3708debe3f7ff9edd0f0a52998ebf7a799bb712f N/A N/A N/A N/A https://git.opnfv.org/edgecloud/tree/docs/development/requirements/requirements.rst?h=stable/gambia&id=3708debe3f7ff9edd0f0a52998ebf7a799bb712f N/A
Yardstick Active https://git.opnfv.org/yardstick/tree/docs?h=stable/gambia N/A N/A https://git.opnfv.org/yardstick/tree/docs/testing/user/userguide?h=stable/gambia N/A https://git.opnfv.org/yardstick/tree/docs/testing/developer/devguide?h=stable/gambia https://git.opnfv.org/yardstick/tree/docs/release/release-notes?h=stable/gambia
Samplevnf Active https://git.opnfv.org/samplevnf/tree/docs?h=stable/gambia N/A N/A https://git.opnfv.org/samplevnf/tree/docs/testing/user/userguide?h=stable/gambia N/A https://git.opnfv.org/samplevnf/tree/docs/testing/developer/devguide?h=stable/gambia https://git.opnfv.org/samplevnf/tree/docs/release/release-notes?h=stable/gambia
Auto Active

yes

https://git.opnfv.org/auto/tree/docs?h=stable/gambia

N/A https://opnfv-auto.readthedocs.io/en/stable-gambia/release/configguide/index.html https://opnfv-auto.readthedocs.io/en/stable-gambia/release/userguide/index.html N/A N/A https://opnfv-auto.readthedocs.io/en/stable-gambia/release/release-notes/index.html
SFC Active yes
https://git.opnfv.org/sfc/tree/docs?h=stable/gambia
N/A https://opnfv-sfc.readthedocs.io/en/stable-gambia/release/configguide/index.html https://opnfv-sfc.readthedocs.io/en/stable-gambia/release/userguide/index.html

os-odl-sfc-noha
https://github.com/opnfv/sfc/blob/master/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst


os-odl-sfc-ha

https://github.com/opnfv/sfc/blob/master/docs/release/scenarios/os-odl-sfc-ha/scenario.description.rst

N/A https://github.com/opnfv/sfc/blob/master/docs/release/release-notes/releasenotes.rst
Compass4nfv Active https://git.opnfv.org/compass4nfv/tree/docs?h=stable/gambia https://git.opnfv.org/compass4nfv/tree/docs/release/installation?h=stable/gambia N/A https://git.opnfv.org/compass4nfv/tree/docs/release/userguide?h=stable/gambia


StorPerf Active https://git.opnfv.org/storperf/tree/docs?h=stable/gambia N/A

https://git.opnfv.org/storperf/tree/docs/testing/user/installation.rst?h=stable/gambia

https://git.opnfv.org/storperf/tree/docs/testing/user/introduction.rst?h=stable/gambia

https://git.opnfv.org/storperf/tree/docs/testing/user/test-usage.rst?h=stable/gambia


N/A https://git.opnfv.org/storperf/tree/docs/testing/developer/devguide?h=stable/gambia https://git.opnfv.org/storperf/tree/docs/release/release-notes/release-notes.rst?h=stable/gambia
NFVbench Acive https://git.opnfv.org/nfvbench/tree/docs?h=stable/gambia N/A https://git.opnfv.org/nfvbench/tree/docs/testing/user/userguide/installation.rst?h=stable/gambia



Vswitchperf Active https://git.opnfv.org/vswitchperf/tree/docs?h=stable/gambia N/A https://git.opnfv.org/vswitchperf/tree/docs/testing/user/configguide https://git.opnfv.org/vswitchperf/tree/docs/testing/user/userguide N/A https://git.opnfv.org/vswitchperf/tree/docs/testing/developer/devguide https://git.opnfv.org/vswitchperf/tree/docs/release/release-notes
Bottlenecks Active https://git.opnfv.org/bottlenecks/tree/docs?h=stable/gambia N/A N/A https://git.opnfv.org/bottlenecks/tree/docs/testing/user/userguide?h=stable/gambia N/A https://git.opnfv.org/bottlenecks/tree/docs/testing/developer/devguide?h=stable/gambia https://git.opnfv.org/bottlenecks/tree/docs/release/release-notes?h=stable/gambia
Barometer Active https://git.opnfv.org/barometer/tree/docs/?h=stable/gambia
https://git.opnfv.org/barometer/tree/docs/release/configguide?h=stable/gambia
https://git.opnfv.org/calipso/tree/docshttps://git.opnfv.org/barometer/tree/docs/release/scenarios?h=stable/gambia

Linking to Release Notes from Release File

Once release notes are available on docs.opnfv.org, please do the following in the releng repo:

  1. Checkout the file releases/gambia/<project>.yaml
  2. Locate the key release-notes
  3. Add a link (URL) to your release notes as a value for the key (see example below)



release/gambia/<project>.yaml (Note: replace <project> with your project name)

---
project: <project>
 
releases: ...
branches: ...
 
release-notes: http://docs.opnfv.org/en/stable-gamba/submodules/<project>/docs/release/release-notes/release-notes.html

 

 

  • No labels