diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9d9fdc34..858f67bf 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -9,9 +9,9 @@ to set up and use Gerrit: 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 Cyborg contributor guide: diff --git a/README.rst b/README.rst index b0b474ad..826423af 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ -=============================== +====== Cyborg -=============================== +====== 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 * Wiki: https://wiki.openstack.org/wiki/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/ * Release notes: https://docs.openstack.org/releasenotes/cyborg/ * Design specifications: https://specs.openstack.org/openstack/cyborg-specs/ diff --git a/doc/source/conf.py b/doc/source/conf.py index b6dfb8a2..51fe2ac8 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,4 +1,3 @@ -# -*- 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 @@ -11,6 +10,12 @@ # implied. # See the License for the specific language governing permissions and # 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 sys @@ -46,10 +51,12 @@ copyright = '2013, OpenStack Foundation' # openstackdocstheme options openstackdocs_repo_name = 'openstack/cyborg' +openstackdocs_bug_project = 'cyborg' +openstackdocs_bug_tag = 'doc' 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' policy_generator_config_file = [ @@ -76,7 +83,7 @@ pygments_style = 'native' # 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, # 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. htmlhelp_basename = 'cyborgdoc' @@ -119,4 +126,4 @@ latex_documents = [ ] # Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'https://docs.python.org/': None} +# intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index 46cc22d8..21469649 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -31,16 +31,15 @@ New Feature Planning ~~~~~~~~~~~~~~~~~~~~ To propose or plan new features, we add a new story in the -`Cyborg Storyboard -`_ +`Cyborg Launchpad +`_ and/or propose a specification in the `cyborg-specs `_ repository. Task Tracking ~~~~~~~~~~~~~ -We track our tasks in the `Cyborg Storyboard -`_. +We track our tasks in the `Launchpad `_. If you're looking for some smaller, easier work item to pick up and get started on, ask in the IRC meeting. @@ -48,10 +47,10 @@ on, ask in the IRC meeting. Reporting a Bug ~~~~~~~~~~~~~~~ -You found an issue and want to make sure we are aware of it? You can do so -by adding an entry in the `Cyborg Storyboard -`_ or raising -it in the IRC meeting. +You found an issue and want to make sure we are aware of it? You can do so on +`Launchpad `__. +More info about Launchpad usage can be found on `OpenStack docs page +`_. Getting Your Patch Merged ~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/contributor/releasenotes.rst b/doc/source/contributor/releasenotes.rst index 68cb15b0..16abaf1f 100644 --- a/doc/source/contributor/releasenotes.rst +++ b/doc/source/contributor/releasenotes.rst @@ -53,7 +53,7 @@ need to provide a release note :-) :doc:`DriversSupportMatrix ` * ``critical`` - * Bugfixes categorized as Critical in storyboard *impacting users* + * Bugfixes categorized as Critical in launchpad *impacting users* * ``fixes`` * No clear definition of such bugfixes. Hairy long-standing bugs with high diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 630bf104..ef2ac5be 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -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 ------------------------------------------------ @@ -16,7 +39,9 @@ extensions = [ # openstackdocstheme options 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. # You can specify multiple suffix as a list of string: