openstack/openstack-manuals
Code Issues Proposed changes

[Contributor Guide] Publishing

Browse Source 
1. Updates tools/build-all-rst.sh so that it does not get published
to /draft.
2. Updates www/templates/contributor_guides.tmpl with the link and name
of the new guide.
3. Updates the How to Contribute link on the index.html pages.

Change-Id: If2331b393e1998d5f561cf4c2662c76cf507ced0
Implements: blueprint docs-contributor-guide
This commit is contained in:
OlgaGusarenko 2015-10-23 15:57:00 +03:00
parent c0cd0f04f0
commit e16c6d9493
8 changed files with 12 additions and 16 deletions

10
tools/build-all-rst.sh

@ -11,7 +11,7 @@ if [[ $# > 0 ]] ; then
fi
fi
for guide in user-guide user-guide-admin networking-guide admin-guide-cloud; do
for guide in user-guide user-guide-admin networking-guide admin-guide-cloud contributor-guide; do
tools/build-rst.sh doc/$guide $GLOSSARY --build build \
--target $guide $LINKCHECK
# Build it only the first time
@ -19,9 +19,9 @@ for guide in user-guide user-guide-admin networking-guide admin-guide-cloud; do
done
# Draft guides
for guide in contributor-guide; do
tools/build-rst.sh doc/$guide --build build \
--target "draft/$guide" $LINKCHECK
done
# for guide in guide_name; do
# tools/build-rst.sh doc/$guide --build build \
# --target "draft/$guide" $LINKCHECK
# done
tools/build-install-guides-rst.sh $LINKCHECK

6
www/draft/draft-index.html

@ -78,10 +78,6 @@
<h3><i class="fa fa-wrench"></i>Draft Configuration Guides</h3>
<a href="/draft/config-reference/content/">Configuration Reference</a>
</div>
<div class="docs-link-sections">
<h3><i class="fa fa-users"></i>Draft Contribution Guides</h3>
<a href="/draft/contributor-guide/">Draft OpenStack Documentation Contributor Guide</a>
</div>
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>Draft API Guides</h3>
<a href="http://developer.openstack.org/draft/firstapp-dotnet/">Writing Your First Application: .Net</a>
@ -119,7 +115,7 @@
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="https://wiki.openstack.org/wiki/Documentation/HowTo" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
<a href="http://docs.openstack.org/contributor-guide/index.html" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>

2
www/icehouse/index.html

@ -118,7 +118,7 @@
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="https://wiki.openstack.org/wiki/Documentation/HowTo" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
<a href="http://docs.openstack.org/contributor-guide/index.html" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>

2
www/index.html

@ -134,7 +134,7 @@
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="https://wiki.openstack.org/wiki/Documentation/HowTo" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
<a href="http://docs.openstack.org/contributor-guide/index.html" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>

2
www/juno/index.html

@ -125,7 +125,7 @@
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="https://wiki.openstack.org/wiki/Documentation/HowTo" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
<a href="http://docs.openstack.org/contributor-guide/index.html" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>

2
www/kilo/index.html

@ -133,7 +133,7 @@
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="https://wiki.openstack.org/wiki/Documentation/HowTo" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
<a href="http://docs.openstack.org/contributor-guide/index.html" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>

2
www/liberty/index.html

@ -134,7 +134,7 @@
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="https://wiki.openstack.org/wiki/Documentation/HowTo" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
<a href="http://docs.openstack.org/contributor-guide/index.html" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>

2
www/templates/contributor_guides.tmpl

@ -1,7 +1,7 @@
<div class="docs-link-sections">
<h3 id="contributor-guides"><i class="fa fa-pencil"></i> Contributor Guides</h3>
<a href="http://wiki.openstack.org/Documentation/HowTo">OpenStack Documentation</a>
<a href="http://docs.openstack.org/contributor-guide/index.html">OpenStack Documentation Contributor Guide</a>
<a href="/developer/openstack-projects.html">Python Developer Documentation</a>
<a href="/developer/language-bindings.html">Language Bindings and Python Clients</a>
<a href="/project-team-guide/">OpenStack Project Team Guide</a>