Skip to content

Commit 90ec427

Browse files
committed
fix(docs): move subheaders down a level for correct nav
The "PR Checklist" doc had all its subheaders at the same level as the main header (h1 instead of h2), causing them to show up in the right column navigation links.
1 parent ebf59a8 commit 90ec427

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/contributing/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:title: Contributing
2-
:description: TOOD
2+
:description: How to contribute to the Deis open source PaaS project
33

44
Contributing
55
============

docs/contributing/standards.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Please make sure your PR follows this checklist:
1919

2020

2121
Single Issue
22-
============
22+
------------
2323

2424
When fixing or implementing a GitHub issue, resist the temptation to refactor
2525
nearby code or to fix that potential bug you noticed. Instead, open a new
@@ -39,7 +39,7 @@ will then be closed when your PR is merged.
3939

4040

4141
Include Tests
42-
=============
42+
-------------
4343

4444
While working on local code changes, run Deis' tests:
4545

@@ -68,7 +68,7 @@ See ``tests/README.md`` in the code for more information.
6868

6969

7070
Include Docs
71-
============
71+
------------
7272

7373
Any change to Deis that could affect a user's experience also needs a change or
7474
addition to the relevant documentation. Deis generates the HTML documentation
@@ -79,7 +79,7 @@ See ``docs/README.md`` in the code for more information.
7979

8080

8181
Code Standards
82-
==============
82+
--------------
8383

8484
Deis is a Go_ and Python_ project. For both languages, we agree with
8585
`The Zen of Python`_, which emphasizes simple over clever. Readability counts.
@@ -99,7 +99,7 @@ Deis does not enforce this.
9999
.. _commit_style_guide:
100100

101101
Commit Style
102-
============
102+
------------
103103

104104
``git commit`` messages must follow this format::
105105

@@ -164,7 +164,7 @@ for manual testing.
164164

165165

166166
Merge Approval
167-
==============
167+
--------------
168168

169169
Deis maintainers add "**LGTM**" (Looks Good To Me) or an equivalent comment
170170
to indicate that a PR is acceptable. Any code change--other than

0 commit comments

Comments
 (0)