diff options
author | Aric Gardner <agardner@linuxfoundation.org> | 2018-11-22 15:54:47 -0500 |
---|---|---|
committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-11-22 15:57:38 -0500 |
commit | 958cc18c64b72da4547839b41633393e8d0293ea (patch) | |
tree | e74e48c218553a842353699b0f24a85f8198b585 | |
parent | dcf106399368fdade5a687ebae1572a7e0ae27d4 (diff) |
Initial Commit for Rocket project
Docs can be built with tox -e docs
INFO.yaml will be populated once committers have accepted their
invitations. (we don't know the id or name yet as the accounts may
not have been created yet)
Change-Id: I7c097b5fdf596374fa5ec31c39a31994754031ca
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | .gitreview | 5 | ||||
-rw-r--r-- | INFO.yaml | 47 | ||||
-rw-r--r-- | LICENSE | 13 | ||||
-rw-r--r-- | docs/conf.py | 1 | ||||
-rw-r--r-- | docs/conf.yaml | 3 | ||||
-rw-r--r-- | docs/index.rst | 14 | ||||
-rw-r--r-- | docs/requirements.txt | 2 | ||||
-rw-r--r-- | tox.ini | 17 |
9 files changed, 104 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..71d7636 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.tox +docs/_build/* diff --git a/.gitreview b/.gitreview new file mode 100644 index 0000000..767393b --- /dev/null +++ b/.gitreview @@ -0,0 +1,5 @@ +[gerrit] +host=gerrit.opnfv.org +port=29418 +project=rocket.git +defaultbranch=master diff --git a/INFO.yaml b/INFO.yaml new file mode 100644 index 0000000..6410d75 --- /dev/null +++ b/INFO.yaml @@ -0,0 +1,47 @@ +--- +project: 'Rocket (hardware-accelerated VNF)' +project_creation_date: '2018-09-10' +project_category: '' +lifecycle_state: 'Incubation' +project_lead: &_ptl + name: '' + email: 'guoshasha@chinamobile.com' + id: '' + company: '' + timezone: '' +primary_contact: *_ptl +issue_tracking: + type: 'jira' + url: 'https://jira.opnfv.org/projects/ROCKET' + key: 'ROCKET' +mailing_list: + type: 'groups.io' + url: 'https://lists.opnfv.org/g/opnfv-tech-discuss' + tag: '[rocket]' +realtime_discussion: + type: 'irc' + server: 'freenode.net' + channel: '#opnfv-rocket' +meetings: + - type: '' + agenda: '' + url: '' + server: '' + channel: '' + repeats: '' + time: '' +repositories: + - 'rocket' +committers: + - <<: *_ptl + +tsc: + # yamllint disable rule:line-length + approval: '' + changes: + - type: 'removal' + name: '' + link: '' + - type: 'promotion' + name: '' + link: '' @@ -0,0 +1,13 @@ +Copyright 2018 Open Platform for NFV Project, Inc. and its contributors + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..eb12e74 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * # noqa: F401,F403 diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..49b3991 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: ROCKET diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..7b5acb2 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,14 @@ +.. _rocket: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. SPDX-License-Identifier CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +********************************* +OPNFV Rocket +********************************* + +.. toctree:: + :numbered: + :maxdepth: 3 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..9fde2df --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx_opnfv_theme @@ -0,0 +1,17 @@ +[tox] +minversion = 1.6 +envlist = + docs, + docs-linkcheck +skipsdist = true + +[testenv:docs] +deps = -rdocs/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |