Skip to content

Commit

Permalink
new sectioning
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefano David committed Aug 21, 2018
1 parent ba1716f commit e821c9a
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 8 deletions.
4 changes: 2 additions & 2 deletions source/architecture.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _architecture-odh:

Architecture
============
|ODH| Architecture
==================

The architecture of the |odh| is depicted in :numref:`arch-odh`, which
shows its composing elements together with its main goal: To gather
Expand Down
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['replace.rst', 'dtp.rst', 'datasets']
exclude_patterns = ['replace.rst', 'dtp.rst', 'datasets', 'domains.rst']

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down
6 changes: 6 additions & 0 deletions source/corehacker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ As a |odh| Core Hacker I can...
guidelines/introduction
guidelines/platform
guidelines/database
architecture
howto/development

...help shape the future of |odh|\.
Expand All @@ -31,6 +32,9 @@ tasks to be carried out:
separate parts: :doc:`guidelines/platform` and
:doc:`guidelines/database`.

#. Understand the :doc:`architecture <architecture>` of both the |odh|
and |bdp|\.
#. Learn about the :ref:`dtp-env`.
#. Install the necessary software on your local workstation (be it a
physical workstation, a virtual machine, or a Docker instance),
including PostgreSQL with postgis extension, JDK, git.
Expand All @@ -43,6 +47,8 @@ tasks to be carried out:
the required set up and configuration, along with some
troubleshooting advice.



#. Coding.

That's the funniest part, enjoy!
Expand Down
3 changes: 3 additions & 0 deletions source/dtp.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

.. _dtp-env:

Development, Testing, and Production Environments
=================================================

Expand Down
7 changes: 2 additions & 5 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,13 @@ Welcome to |odh| Documentation Repository!
:includehidden:
:caption: Table of Contents

intro
domains
Introduction & Project Overview <intro>
datasets
architecture
contribute
user
developer
corehacker
glossary
licenses
appendices

..
Indices and tables
Expand Down
1 change: 1 addition & 0 deletions source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ The technical stuff is composed of:
* Links to the full API documentation.


.. include:: /domains.rst

0 comments on commit e821c9a

Please sign in to comment.