Skip to content

Commit

Permalink
Added a page for the WIP style guide, rather than having it on the wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
archaeogeek committed Nov 25, 2019
1 parent da28a09 commit 9b525d1
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
1 change: 1 addition & 0 deletions source/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ The guide for people who want to contribute to GeoNetwork.
:maxdepth: 2

writing-documentation.rst
style-guide.rst
translating.rst
making-a-pull-request.rst
doing-a-release.rst
20 changes: 20 additions & 0 deletions source/contributing/style-guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. _style-guide:


Style Guide
###########

This is a work-in-progress style guide to help creating consistent documentation
for |project_name|.


Preferred Terminology
---------------------

- Catalog Home Page
- GeoNetwork (check capitalisation, or preferrably use the ``|project_name|`` variable)
- Metadata Catalog
- Sub-Portal



3 changes: 2 additions & 1 deletion source/contributing/writing-documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ Once the documentation has built without errors, access the html files from ``do
Editing the reStructuredText files
==================================

To update the documentation, use a text editor to edit ``.rst`` files. Save
To update the documentation, use a text editor to edit ``.rst`` files. Ensure you are using the correct terminology by
checking :ref:`style-guide`. Save
your changes, build the documentation and open the HTML files to preview
the changes. When your changes are ready to be submitted to the project, follow
the steps in :ref:`making-a-pull-request`.
Expand Down

0 comments on commit 9b525d1

Please sign in to comment.