Switch using Launchpad instead of Storyboard
In Xena release, we will using launchpad to trace Cyborg feature and bugs, this patch changes the docs and releasenote config to launchpad. Xena-PTG Etherpad: https://etherpad.opendev.org/p/cyborg-xena-ptg Change-Id: I29c134420d341977a68ab11ba7dcb425caea44ff
This commit is contained in:
parent
025188ce27
commit
d9233bc429
@ -9,9 +9,9 @@ to set up and use Gerrit:
|
|||||||
|
|
||||||
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
||||||
|
|
||||||
Bugs should be filed on Storyboard:
|
Bugs should be filed on Launchpad:
|
||||||
|
|
||||||
https://storyboard.openstack.org/#!/project/openstack/cyborg
|
https://bugs.launchpad.net/openstack-cyborg
|
||||||
|
|
||||||
For more specific information about contributing to this repository, see the
|
For more specific information about contributing to this repository, see the
|
||||||
Cyborg contributor guide:
|
Cyborg contributor guide:
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
===============================
|
======
|
||||||
Cyborg
|
Cyborg
|
||||||
===============================
|
======
|
||||||
|
|
||||||
OpenStack Acceleration as a Service
|
OpenStack Acceleration as a Service
|
||||||
|
|
||||||
@ -10,7 +10,8 @@ FPGA, GPU, SoCs, NVMe SSDs, CCIX caches, DPDK/SPDK, pmem and so forth.
|
|||||||
* Free software: Apache license
|
* Free software: Apache license
|
||||||
* Wiki: https://wiki.openstack.org/wiki/Cyborg
|
* Wiki: https://wiki.openstack.org/wiki/Cyborg
|
||||||
* Source: https://opendev.org/openstack/cyborg
|
* Source: https://opendev.org/openstack/cyborg
|
||||||
* Blueprints and Bugs: https://storyboard.openstack.org/#!/project/openstack/cyborg
|
* Blueprints: https://blueprints.launchpad.net/openstack-cyborg
|
||||||
|
* Bugs: https://bugs.launchpad.net/openstack-cyborg
|
||||||
* Documentation: https://docs.openstack.org/cyborg/latest/
|
* Documentation: https://docs.openstack.org/cyborg/latest/
|
||||||
* Release notes: https://docs.openstack.org/releasenotes/cyborg/
|
* Release notes: https://docs.openstack.org/releasenotes/cyborg/
|
||||||
* Design specifications: https://specs.openstack.org/openstack/cyborg-specs/
|
* Design specifications: https://specs.openstack.org/openstack/cyborg-specs/
|
||||||
|
@ -1,4 +1,3 @@
|
|||||||
# -*- coding: utf-8 -*-
|
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
# you may not use this file except in compliance with the License.
|
# you may not use this file except in compliance with the License.
|
||||||
# You may obtain a copy of the License at
|
# You may obtain a copy of the License at
|
||||||
@ -11,6 +10,12 @@
|
|||||||
# implied.
|
# implied.
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# cyborg documentation build configuration file
|
||||||
|
#
|
||||||
|
# Refer to the Sphinx documentation for advice on configuring this file:
|
||||||
|
#
|
||||||
|
# http://www.sphinx-doc.org/en/stable/config.html
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
@ -46,10 +51,12 @@ copyright = '2013, OpenStack Foundation'
|
|||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
openstackdocs_repo_name = 'openstack/cyborg'
|
openstackdocs_repo_name = 'openstack/cyborg'
|
||||||
|
openstackdocs_bug_project = 'cyborg'
|
||||||
|
openstackdocs_bug_tag = 'doc'
|
||||||
openstackdocs_pdf_link = True
|
openstackdocs_pdf_link = True
|
||||||
openstackdocs_use_storyboard = True
|
|
||||||
|
|
||||||
config_generator_config_file = '../../tools/config/cyborg-config-generator.conf'
|
config_generator_config_file = \
|
||||||
|
'../../tools/config/cyborg-config-generator.conf'
|
||||||
sample_config_basename = '_static/cyborg'
|
sample_config_basename = '_static/cyborg'
|
||||||
|
|
||||||
policy_generator_config_file = [
|
policy_generator_config_file = [
|
||||||
@ -76,7 +83,7 @@ pygments_style = 'native'
|
|||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
#html_static_path = ['_static']
|
# html_static_path = ['_static']
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'cyborgdoc'
|
htmlhelp_basename = 'cyborgdoc'
|
||||||
@ -119,4 +126,4 @@ latex_documents = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
# Example configuration for intersphinx: refer to the Python standard library.
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
#intersphinx_mapping = {'https://docs.python.org/': None}
|
# intersphinx_mapping = {'https://docs.python.org/': None}
|
||||||
|
@ -31,16 +31,15 @@ New Feature Planning
|
|||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
To propose or plan new features, we add a new story in the
|
To propose or plan new features, we add a new story in the
|
||||||
`Cyborg Storyboard
|
`Cyborg Launchpad
|
||||||
<https://storyboard.openstack.org/#!/project/openstack/cyborg>`_
|
<https://blueprints.launchpad.net/openstack-cyborg>`_
|
||||||
and/or propose a specification in the
|
and/or propose a specification in the
|
||||||
`cyborg-specs <https://opendev.org/openstack/cyborg-specs>`_ repository.
|
`cyborg-specs <https://opendev.org/openstack/cyborg-specs>`_ repository.
|
||||||
|
|
||||||
Task Tracking
|
Task Tracking
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
We track our tasks in the `Cyborg Storyboard
|
We track our tasks in the `Launchpad <https://bugs.launchpad.net/openstack-cyborg>`_.
|
||||||
<https://storyboard.openstack.org/#!/project/openstack/cyborg>`_.
|
|
||||||
|
|
||||||
If you're looking for some smaller, easier work item to pick up and get started
|
If you're looking for some smaller, easier work item to pick up and get started
|
||||||
on, ask in the IRC meeting.
|
on, ask in the IRC meeting.
|
||||||
@ -48,10 +47,10 @@ on, ask in the IRC meeting.
|
|||||||
Reporting a Bug
|
Reporting a Bug
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
You found an issue and want to make sure we are aware of it? You can do so
|
You found an issue and want to make sure we are aware of it? You can do so on
|
||||||
by adding an entry in the `Cyborg Storyboard
|
`Launchpad <https://bugs.launchpad.net/openstack-cyborg/+filebug>`__.
|
||||||
<https://storyboard.openstack.org/#!/project/openstack/cyborg>`_ or raising
|
More info about Launchpad usage can be found on `OpenStack docs page
|
||||||
it in the IRC meeting.
|
<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_.
|
||||||
|
|
||||||
Getting Your Patch Merged
|
Getting Your Patch Merged
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -53,7 +53,7 @@ need to provide a release note :-)
|
|||||||
:doc:`DriversSupportMatrix </reference/support-matrix>`
|
:doc:`DriversSupportMatrix </reference/support-matrix>`
|
||||||
|
|
||||||
* ``critical``
|
* ``critical``
|
||||||
* Bugfixes categorized as Critical in storyboard *impacting users*
|
* Bugfixes categorized as Critical in launchpad *impacting users*
|
||||||
|
|
||||||
* ``fixes``
|
* ``fixes``
|
||||||
* No clear definition of such bugfixes. Hairy long-standing bugs with high
|
* No clear definition of such bugfixes. Hairy long-standing bugs with high
|
||||||
|
@ -1,4 +1,27 @@
|
|||||||
# -*- coding: utf-8 -*-
|
# 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.
|
||||||
|
|
||||||
|
# Cyborg Release Notes documentation build configuration file, created by
|
||||||
|
# sphinx-quickstart on Thu April 1 16:50:32 2020.
|
||||||
|
#
|
||||||
|
# This file is execfile()d with the current directory set to its
|
||||||
|
# containing dir.
|
||||||
|
#
|
||||||
|
# Note that not all possible configuration values are present in this
|
||||||
|
# autogenerated file.
|
||||||
|
#
|
||||||
|
# All configuration values have a default; values that are commented out
|
||||||
|
# serve to show the default.
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
@ -16,7 +39,9 @@ extensions = [
|
|||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
openstackdocs_repo_name = 'openstack/cyborg'
|
openstackdocs_repo_name = 'openstack/cyborg'
|
||||||
openstackdocs_use_storyboard = True
|
openstackdocs_bug_project = 'cyborg'
|
||||||
|
openstackdocs_bug_tag = 'doc'
|
||||||
|
openstackdocs_pdf_link = True
|
||||||
|
|
||||||
# The suffix(es) of source filenames.
|
# The suffix(es) of source filenames.
|
||||||
# You can specify multiple suffix as a list of string:
|
# You can specify multiple suffix as a list of string:
|
||||||
|
Loading…
Reference in New Issue
Block a user