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)

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
Doctor Active

yes

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

n/a

yes

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

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
Samplevnf Active

yes

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

n/a n/a https://git.opnfv.org/samplevnf/tree/docs/testing/user/userguide n/a https://git.opnfv.org/samplevnf/tree/docs/testing/developer https://git.opnfv.org/samplevnf/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
Stor4NFV Active

yes

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

n/a

n/a

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
Bottlenecks Active

yes

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
Yardstick Active https://git.opnfv.org/yardstick/tree/docs/ N/A N/A https://git.opnfv.org/yardstick/tree/docs/testing/user/userguide
https://git.opnfv.org/yardstick/tree/docs/testing/developer/devguide https://git.opnfv.org/yardstick/tree/docs/release/release-notes
Functest Active https://git.opnfv.org/functest/tree/docs?h=stable%2Fhunter N/A https://functest.readthedocs.io/en/stable-hunter/testing/user/configguide/index.html https://functest.readthedocs.io/en/stable-hunter/testing/user/userguide/index.html N/A https://functest.readthedocs.io/en/stable-hunter/testing/developer/devguide/index.html https://functest.readthedocs.io/en/stable-hunter/release/release-notes/index.html
Clover Active https://git.opnfv.org/clover/tree/docs N/A https://git.opnfv.org/clover/tree/docs/release/configguide https://git.opnfv.org/clover/tree/docs/release/userguide N/A N/A https://git.opnfv.org/clover/tree/docs/release/release-notes
Calipso Active https://git.opnfv.org/calipso/tree/docs https://git.opnfv.org/calipso/tree/docs/release/install-guide.rst https://git.opnfv.org/calipso/tree/docs/release/quickstart-guide.rst https://git.opnfv.org/calipso/tree/docs/release/admin-guide.rst N/A https://git.opnfv.org/calipso/tree/docs/release/developer-guide.rst https://git.opnfv.org/calipso/tree/docs/release/apex-scenario-guide.rst
vSwitchPerf Active https://git.opnfv.org/vswitchperf/tree/docs/ 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
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
High availability active https://git.opnfv.org/availability/tree/docs N/A N/A N/A
https://git.opnfv.org/availability/tree/docs/development/overview
FastDataStacks Active https://git.opnfv.org/fds/tree/docs N/A N/A N/A https://git.opnfv.org/fds/tree/docs/scenarios/os-nosdn-fdio-ha
https://git.opnfv.org/fds/tree/docs/scenarios/os-nosdn-fdio-noha 
N/A https://git.opnfv.org/fds/tree/docs/release/release-notes
OPNFVDOCS Active https://git.opnfv.org/opnfvdocs/tree/docs https://git.opnfv.org/opnfvdocs/tree/docs/release/installation.introduction.rst https://git.opnfv.org/opnfvdocs/tree/docs/release/userguide.introduction.rst


https://git.opnfv.org/opnfvdocs/tree/docs/release/release-notes.rst
NFVbench Active https://git.opnfv.org/nfvbench/tree/docs (user guide) (user guide) https://git.opnfv.org/nfvbench/tree/docs/testing/user/userguide N/A https://git.opnfv.org/nfvbench/tree/docs/development/design
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
Barometer Active https://git.opnfv.org/barometer/tree/docs N/A https://git.opnfv.org/barometer/tree/docs/release/configguide https://git.opnfv.org/barometer/tree/docs/release/userguide


SNAPS Active https://git.opnfv.org/snaps/tree/docs see user guide see user guide SNAPS-OO Library Usage N/A see user guide N/A
cran Active

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

https://git.opnfv.org/cran/tree/docs/release/installation N/A https://git.opnfv.org/cran/tree/docs/release/userguide https://git.opnfv.org/cran/tree/docs/release/scenarios/ N/A https://git.opnfv.org/cran/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)

Functest Active https://git.opnfv.org/functest/tree/docs?h=stable%2Fhunter N/A https://functest.readthedocs.io/en/stable-hunter/testing/user/configguide/index.html https://functest.readthedocs.io/en/stable-hunter/testing/user/userguide/index.html N/A https://functest.readthedocs.io/en/stable-hunter/testing/developer/devguide/index.html https://functest.readthedocs.io/en/stable-hunter/release/release-notes/index.html
Doctor Active

yes

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

n/a

yes

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

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
Stor4NFV Active

yes

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

n/a n/a 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
Yardstick Active

yes

https://git.opnfv.org/yardstick/log/?h=stable/hunter

n/a n/a https://git.opnfv.org/yardstick/tree/docs/testing/user/userguide?h=stable/hunter n/a https://git.opnfv.org/yardstick/tree/docs/testing/developer/devguide?h=stable/hunter https://git.opnfv.org/yardstick/tree/docs/release/release-notes?h=stable/hunter
IPv6 Active Yes, 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
Clover Active

yes

https://git.opnfv.org/clover/tree/docs?h=stable%2Fhunter


N/A

yes

https://git.opnfv.org/clover/tree/docs/release/configguide?h=stable/hunter

yes

https://git.opnfv.org/clover/tree/docs/release/userguide?h=stable/hunter

N/A N/A

yes

https://git.opnfv.org/clover/tree/docs/release/release-notes/release-notes.rst?h=stable/hunter

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
 cran  Active

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

yes

 https://git.opnfv.org/cran/tree/docs/release/installation  N/A  N/A  N/A  N/A  https://git.opnfv.org/cran/tree/docs/release/release-notes
barometer Active

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

N/A https://git.opnfv.org/barometer/tree/docs/release/configguide https://git.opnfv.org/barometer/tree/docs/release/userguide https://git.opnfv.org/barometer/tree/docs/release/scenarios https://git.opnfv.org/barometer/tree/docs/development https://git.opnfv.org/barometer/tree/docs/release/release-notes

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/<release name>/<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/<release>/<project>.yaml (Note: replace <release> with the current release name and <project> with your project name.)

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



  • No labels