openstack/openstack-manuals
Code Issues Proposed changes

Fix over-capitalization of <h3> headings

Browse Source 
It is generally considered good style not to necessarily capitalize
every single word in titles, e.g.

  https://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html

Presumably this is intended to include sub-headings too.

In fact, the OpenStack Documentation Contributor Guide goes even
further away from all capitals:

    Use the following guidelines for all types of headings:

      * Use sentence-style capitalization.
      * ...

    -- https://docs.openstack.org/doc-contrib-guide/writing-style/headings.html

And looking at files such as www/stein/user/index.html, we find headings
such as:

    User Guides for OpenStack Services

and

    User Guides for OpenStack Deployment Tools

where the intention for a lowercase "for" is clear.

So remove the CSS which automatically capitalizes every single word in
headings, and lowercase any remaining articles, prepositions, or
coordinating conjunctions.

Change-Id: I7cc35a1528c0e15c4e1d1fc47d27c2d4ab49e497
This commit is contained in:
Adam Spiers 2019-01-02 18:14:31 +00:00
parent 1c604748aa
commit 809c755219
2 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
www/static/common/css/combined.css
View File

@ -3420,7 +3420,6 @@ a.media-btn.left {
.top-docs-wrapper h3 {
text-align: left;
text-transform: capitalize;
font-weight: 300;
font-size: 24px; }

4
www/stein/index.html
View File

@ -69,7 +69,7 @@
<p>Documentation for the OpenStack Python bindings and clients</p>
</div>
<div class="docs-link-sections">
<h3 id="services-libraries"><i class="fa fa-users-cog"></i>SIG-specific documentation</h3>
<h3 id="services-libraries"><i class="fa fa-users-cog"></i>SIG-specific Documentation</h3>
<a href="https://docs.openstack.org/project-team-guide/stable-branches.html">Extended Maintenance SIG</a>
<p>The Extended Maintenance SIG manages the existing stable branches</p>
<a href="/self-healing-sig/">Self-healing SIG documentation</a>
@ -95,7 +95,7 @@
<p>Influence the future of OpenStack</p>
</div>
<div class="docs-link-sections">
<h3 id="training-guides"><i class="fa fa-university"></i>Training Guides And Training Labs</h3>
<h3 id="training-guides"><i class="fa fa-university"></i>Training Guides and Training Labs</h3>
<a href="/upstream-training/">Upstream training</a>
<p>Resources for the OpenStack Upstream Training program</p>
<a href="/training_labs/">Training Labs</a>