summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/files
diff options
context:
space:
mode:
authorTrevor Bramwell <tbramwell@linuxfoundation.org>2018-09-05 22:39:11 -0700
committerTrevor Bramwell <tbramwell@linuxfoundation.org>2018-09-06 00:24:58 -0700
commitf969fcba17f8fed8983848ea985b0f8da157d152 (patch)
tree7911d240ef3029d2a4497037b7b88a331606f096 /docs/how-to-use-docs/files
parent8368e0d9fa28d8cc3fe491fab7af941e5e79edaa (diff)
Update formatting and expand local build guide
These changes will hopefully make it clearer to people working on transitioning their docs over. Change-Id: I6f9857e53b5981fde4286f1208363a004c7bcbf9 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Diffstat (limited to 'docs/how-to-use-docs/files')
-rw-r--r--docs/how-to-use-docs/files/build.yaml16
-rw-r--r--docs/how-to-use-docs/files/index.rst18
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/how-to-use-docs/files/build.yaml b/docs/how-to-use-docs/files/build.yaml
new file mode 100644
index 000000000..452655ae5
--- /dev/null
+++ b/docs/how-to-use-docs/files/build.yaml
@@ -0,0 +1,16 @@
+---
+- project:
+ name: PROJECT
+ project-name: '{name}'
+
+ build-timeout: 60
+ build-node: 'opnfv-build'
+ gerrit-server-name: 'gerrit.opnfv.org'
+ jenkins-ssh-credential: 'd42411ac011ad6f3dd2e1fa34eaa5d87f910eb2e'
+
+ project-pattern: '{name}'
+ rtd-build-url: RTD_BUILD_URL
+ rtd-token: RTD_TOKEN
+
+ jobs:
+ - '{project-name}-rtd-jobs'
diff --git a/docs/how-to-use-docs/files/index.rst b/docs/how-to-use-docs/files/index.rst
new file mode 100644
index 000000000..0fa6784ab
--- /dev/null
+++ b/docs/how-to-use-docs/files/index.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _<project-name>:
+
+==============
+<project-name>
+==============
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ release/release-notes/index
+ release/installation/index
+ release/userguide/index
+ scenarios/index