openstack
/
openstackdocstheme
Code Issues Proposed changes

Update several links 

Link to Contributor Guide instead of Infra Manual since that is now the
OpenDev Manual.

Update broken security link.

Update links to use https everywhere.

Update CONTRIBUTING.rst with current cookiecutter template.

Change-Id: I9794b46fa1fb9a7a72d4db69e9742c203a2a66b6
This commit is contained in:
Andreas Jaeger 2020-03-21 09:07:50 +01:00
parent 4ecccf9c0c
commit 403c9bca39
10 changed files with 55 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.rst
View File

@ -1,15 +1,13 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps in this page:
The source repository for this project can be found at:
https://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/openstackdocstheme
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
Pull requests submitted through GitHub are not monitored.
https://docs.openstack.org/infra/manual/developers.html#development-workflow
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
Pull requests submitted through GitHub will be ignored.
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Launchpad, using a theme tag:

36
openstackdocstheme/theme/openstackdocs/footer.html
View File

@ -4,38 +4,38 @@
<div class="col-lg-2 col-sm-2">
<h3>OpenStack</h3>
<ul>
<li><a href="http://openstack.org/projects/">Projects</a></li>
<li><a href="http://openstack.org/projects/openstack-security/">OpenStack Security</a></li>
<li><a href="http://openstack.org/projects/openstack-faq/">Common Questions</a></li>
<li><a href="http://openstack.org/blog/">Blog</a></li>
<li><a href="http://openstack.org/news/">News</a></li>
<li><a href="https://openstack.org/projects/">Projects</a></li>
<li><a href="https://www.openstack.org/software/security/">OpenStack Security</a></li>
<li><a href="https://openstack.org/projects/openstack-faq/">Common Questions</a></li>
<li><a href="https://openstack.org/blog/">Blog</a></li>g
<li><a href="https://openstack.org/news/">News</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Community</h3>
<ul>
<li><a href="http://openstack.org/community/">User Groups</a></li>
<li><a href="http://openstack.org/community/events/">Events</a></li>
<li><a href="http://openstack.org/community/jobs/">Jobs</a></li>
<li><a href="http://openstack.org/foundation/companies/">Companies</a></li>
<li><a href="http://docs.openstack.org/infra/manual/developers.html">Contribute</a></li>
<li><a href="https://openstack.org/community/">User Groups</a></li>
<li><a href="https://openstack.org/community/events/">Events</a></li>
<li><a href="https://openstack.org/community/jobs/">Jobs</a></li>
<li><a href="https://openstack.org/foundation/companies/">Companies</a></li>
<li><a href="https://docs.openstack.org/contributors">Contribute</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Documentation</h3>
<ul>
<li><a href="http://docs.openstack.org">OpenStack Manuals</a></li>
<li><a href="http://openstack.org/software/start/">Getting Started</a></li>
<li><a href="http://developer.openstack.org">API Documentation</a></li>
<li><a href="https://docs.openstack.org">OpenStack Manuals</a></li>
<li><a href="https://openstack.org/software/start/">Getting Started</a></li>
<li><a href="https://developer.openstack.org">API Documentation</a></li>
<li><a href="https://wiki.openstack.org">Wiki</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Branding & Legal</h3>
<ul>
<li><a href="http://openstack.org/brand/">Logos & Guidelines</a></li>
<li><a href="http://openstack.org/brand/openstack-trademark-policy/">Trademark Policy</a></li>
<li><a href="http://openstack.org/privacy/">Privacy Policy</a></li>
<li><a href="https://openstack.org/brand/">Logos & Guidelines</a></li>
<li><a href="https://openstack.org/brand/openstack-trademark-policy/">Trademark Policy</a></li>
<li><a href="https://openstack.org/privacy/">Privacy Policy</a></li>
<li><a href="https://wiki.openstack.org/wiki/How_To_Contribute#Contributor_License_Agreement">OpenStack CLA</a></li>
</ul>
</div>
@ -47,8 +47,8 @@
<a href="https://www.youtube.com/user/OpenStackFoundation" target="_blank" class="social-icons footer-youtube"></a>
<p class="fine-print">
The OpenStack project is provided under the
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>. Openstack.org is powered by
<a href="http://rackspace.com" target="_blank">Rackspace Cloud Computing</a>.
<a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>. Openstack.org is powered by
<a href="https://rackspace.com" target="_blank">Rackspace Cloud Computing</a>.
</p>
</div>
</div>

2
openstackdocstheme/theme/openstackdocs/header.html
View File

@ -44,7 +44,7 @@
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/telecoms-and-nfv/">Telecoms and NFV</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/enterprise/">OpenStack in the Enterprise</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/appdev/">Application Developers & ISVs</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://superuser.openstack.org/">Superuser Magazine</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://superuser.openstack.org/">Superuser Magazine</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/surveys/landing">User Survey</a></li>
</ul>
</li>

2
openstackdocstheme/theme/openstackdocs/layout.html
View File

@ -71,7 +71,7 @@ ga('send', 'pageview');
{%- if bug_project %}
<a href="#" id="logABugLink2" class="docs-footer-actions"><i class="fa fa-bug"></i> found an error? report a bug</a>
{%- endif %}
<a href="http://ask.openstack.org" class="docs-footer-actions"><i class="fa fa-question-circle"></i> questions?</a>
<a href="https://ask.openstack.org" class="docs-footer-actions"><i class="fa fa-question-circle"></i> questions?</a>
</div>
</div>
</div>

2
openstackdocstheme/theme/openstackdocs/license_cc.html
View File

@ -4,6 +4,6 @@
<p>
Except where otherwise noted, this document is licensed under
<a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>. See all <a href="http://www.openstack.org/legal">
Attribution 3.0 License</a>. See all <a href="https://www.openstack.org/legal">
OpenStack Legal Documents</a>.
</p>

2
openstackdocstheme/theme/openstackdocs/script_search.html
View File

@ -1,4 +1,4 @@
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script src="https://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
//<![CDATA[
google.load('search', '1', {

30
openstackdocstheme/theme/openstackdocs/sidebartoc_menu.html
View File

@ -1,20 +1,20 @@
<button href="#" type="button" data-toggle="dropdown" class="btn docs-sidebar-release-select">OpenStack Documentation<i class="fa fa-caret-down"></i></button>
<ul class="dropdown-menu docs-sidebar-dropdown" role="menu" aria-labelledby="dLabel">
<li role="presentation" class="dropdown-header">Guides</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#install-guides">Install Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#user-guides">User Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#configuration-guides">Configuration Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#ops-and-admin-guides">Operations and Administration Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#api-guides">API Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#contributor-guides">Contributor Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#install-guides">Install Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#user-guides">User Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#configuration-guides">Configuration Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#ops-and-admin-guides">Operations and Administration Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#api-guides">API Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#contributor-guides">Contributor Guides</a></li>
<li role="presentation" class="dropdown-header">Languages</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/de/">Deutsch (German)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/fr/">Français (French)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/id/">Bahasa Indonesia (Indonesian)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/it/">Italiano (Italian)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/ja/">日本語 (Japanese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/ko_KR/">한국어 (Korean)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/pt_BR/">Português (Portuguese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/tr_TR/">Türkçe (Türkiye)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/zh_CN/">简体中文 (Simplified Chinese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/de/">Deutsch (German)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/fr/">Français (French)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/id/">Bahasa Indonesia (Indonesian)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/it/">Italiano (Italian)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/ja/">日本語 (Japanese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/ko_KR/">한국어 (Korean)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/pt_BR/">Português (Portuguese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/tr_TR/">Türkçe (Türkiye)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/zh_CN/">简体中文 (Simplified Chinese)</a></li>
</ul>

4
openstackdocstheme/theme/openstackdocs/static/js/docs.js
View File

@ -44,8 +44,8 @@ function logABug(bugTitle, bugProject, fieldComment, fieldTags, repositoryName,
"input and output. " + lineFeed + lineFeed +
"If you have a troubleshooting or support issue, use the following " +
" resources:" + lineFeed + lineFeed +
" - Ask OpenStack: http://ask.openstack.org" + lineFeed +
" - The mailing list: http://lists.openstack.org" + lineFeed +
" - Ask OpenStack: https://ask.openstack.org" + lineFeed +
" - The mailing list: https://lists.openstack.org" + lineFeed +
" - IRC: 'openstack' channel on Freenode"+ lineFeed;
var urlBase = "https://bugs.launchpad.net/" + bugProject + "/+filebug?field.title=";

16
openstackdocstheme/theme/starlingxdocs/footer.html
View File

@ -4,23 +4,23 @@
<div class="col-lg-2 col-sm-2">
<h3>StarlingX</h3>
<ul>
<li><a href="http://docs.starlingx.io/projects/">Projects</a></li>
<li><a href="https://docs.starlingx.io/projects/">Projects</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Documentation</h3>
<ul>
<li><a href="http://docs.starlingx.io">StarlingX Manuals</a></li>
<li><a href="http://docs.starlingx.io/api-ref/">API Documentation</a></li>
<li><a href="https://docs.starlingx.io">StarlingX Manuals</a></li>
<li><a href="https://docs.starlingx.io/api-ref/">API Documentation</a></li>
<li><a href="https://wiki.openstack.org/StarlingX">Wiki</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Branding & Legal</h3>
<ul>
<li><a href="http://openstack.org/brand/">Logos & Guidelines</a></li>
<li><a href="http://openstack.org/brand/openstack-trademark-policy/">Trademark Policy</a></li>
<li><a href="http://openstack.org/privacy/">Privacy Policy</a></li>
<li><a href="https://openstack.org/brand/">Logos & Guidelines</a></li>
<li><a href="https://openstack.org/brand/openstack-trademark-policy/">Trademark Policy</a></li>
<li><a href="https://openstack.org/privacy/">Privacy Policy</a></li>
<li><a href="https://wiki.openstack.org/wiki/How_To_Contribute#Contributor_License_Agreement">OpenStack CLA</a></li>
</ul>
</div>
@ -32,8 +32,8 @@
<a href="https://www.youtube.com/user/OpenStackFoundation" target="_blank" class="social-icons footer-youtube"></a>
<p class="fine-print">
The StarlingX project is provided under the
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>. starlingx.io is powered by
<a href="http://rackspace.com" target="_blank">Rackspace Cloud Computing</a>.
<a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>. starlingx.io is powered by
<a href="https://rackspace.com" target="_blank">Rackspace Cloud Computing</a>.
</p>
</div>
</div>

4
openstackdocstheme/theme/starlingxdocs/sidebartoc_menu.html
View File

@ -1,6 +1,6 @@
<button href="#" type="button" data-toggle="dropdown" class="btn docs-sidebar-release-select">StarlingX Documentation<i class="fa fa-caret-down"></i></button>
<ul class="dropdown-menu docs-sidebar-dropdown" role="menu" aria-labelledby="dLabel">
<li role="presentation" class="dropdown-header">Guides</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.starlingx.io">Install Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.starlingx.io/api-ref/">API Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.starlingx.io">Install Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.starlingx.io/api-ref/">API Guides</a></li>
</ul>