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

Milestone 4 - Preliminary Documentation

Project Name Status (Active / Inactive)

Milestone 4 (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)

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
Doctor Active https://git.opnfv.org/doctor/tree/docs N/A 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/release/release-notes
NFVbench Active https://git.opnfv.org/nfvbench/tree/docs https://git.opnfv.org/nfvbench/tree/docs/testing/user/userguide/installation.rst see user guide https://git.opnfv.org/nfvbench/tree/docs/testing/user/userguide/readme.rst N/A N/A https://git.opnfv.org/nfvbench/tree/docs/release/release-notes/release-notes.rst
Airship Active https://git.opnfv.org/airship/tree/docs https://git.opnfv.org/airship/tree/docs/release/installation N/A N/A N/A N/A https://git.opnfv.org/airship/tree/docs/release/release-notes
FastDataStacks Active https://git.opnfv.org/fds/tree/docs N/A N/A N/A https://git.opnfv.org/fuel/tree/docs/release/scenarios/os-nosdn-fdio-noha N/A https://git.opnfv.org/fds/tree/docs/release/release-notes
Stor4NFV Active 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
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
edgecloud Active https://git.opnfv.org/edgecloud/tree/docs N/A N/A N/A N/A https://git.opnfv.org/edgecloud/tree/docs/development/requirements
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/requirements https://git.opnfv.org/barometer/tree/docs/release/release-notes
Rocket Active https://git.opnfv.org/rocket/tree/docs N/A N/A N/A


Yardstick Active https://git.opnfv.org/yardstick/tree/docs N/A N/A https://git.opnfv.org/yardstick/tree/docs/testing/user/userguide N/A https://git.opnfv.org/yardstick/tree/docs/testing/developer/devguide https://git.opnfv.org/yardstick/tree/docs/release/release-notes
StorPerf Active https://git.opnfv.org/storperf/tree/docs N/A N/A https://git.opnfv.org/storperf/tree/docs/testing/user N/A https://git.opnfv.org/storperf/tree/docs/testing/developer/devguide https://git.opnfv.org/storperf/tree/docs/release/release-notes








































































Milestone 7 - 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)

Airship Active https://git.opnfv.org/airship/tree/docs https://git.opnfv.org/airship/tree/docs/release/installation N/A N/A N/A N/A https://git.opnfv.org/airship/tree/docs/release/release-notes
Doctor Active https://git.opnfv.org/doctor/tree/docs N/A 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/release/release-notes
StorPerf Active https://git.opnfv.org/storperf/tree/docs N/A N/A https://opnfv-storperf.readthedocs.io/en/latest/testing/user/index.html N/A https://opnfv-storperf.readthedocs.io/en/latest/testing/developer/devguide/index.html https://opnfv-storperf.readthedocs.io/en/latest/release/release-notes/release-notes.html
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/release_notes.rst
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 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



























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