Skip to content

Commit

Permalink
use :ref: to fix numerous links that worked locally but not on RTD #121
Browse files Browse the repository at this point in the history
  • Loading branch information
mradamcox committed Jul 3, 2019
1 parent 698089d commit 5b4e8f7
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/arches-and-elasticsearch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ At some point, you may need to reindex the entire database. This can be helpful

python manage.py es index_database

Be warned that this process can take a long time if you have a lot of resources in your database. Also, if you are in ``DEBUG`` mode it can cause your server to run out of memory (`more info <command-line-reference.html#reindex-the-database>`_).
Be warned that this process can take a long time if you have a lot of resources in your database. Also, if you are in ``DEBUG`` mode it can cause your server to run out of memory (see :ref:`reindex the database`).

If the ``es index_database`` operation doesn't solve your issue, you can try this series of commands::

Expand Down
20 changes: 10 additions & 10 deletions docs/data-model.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,19 +72,19 @@ their more succinct "controller" name.

``ResourceInstance`` breaks the implicit naming convention above
because the term "Resource Model" refers to a specific Arches
construct, as explained `above <#resource-model-overview>`_.
construct, as explained in the :ref:`Resource Model Overview` above.

****************
Graph Definition
****************

A Graph is a collection of `NodeGroups <#nodegroup>`_, `Nodes
<#node>`_, and `Edges <#edge>`_ which connect the Nodes.
A Graph is a collection of :ref:`NodeGroups <nodegroup>`, :ref:`Nodes
<node>`, and :ref:`Edges <edge>` which connect the Nodes.

.. note::

This definition does not include UI models and attributes, which
are discussed `below <#ui-component-models>`_
are discussed :ref:`below <ui component models>`.

In the Arches data model, Nodes represent their graph data structure
namesakes, sometimes called `vertices`. A Node does the work of
Expand All @@ -104,7 +104,7 @@ contain a ``Name Type.E55`` Node. This way, a Graph with this
NodeGroup may store Names with multiple "types", always collecting the
information together.

NodeGroups are used to create `Cards <#cardmodel>`_, and this is done
NodeGroups are used to create :ref:`Cards <cardmodel>`, and this is done
based on the ``cardinality`` property. Therefore, not every NodeGroup
will be used to create a Card, which allows NodeGroups to exist within
other NodeGroups. The ``parentnodegroup`` property is used to record
Expand Down Expand Up @@ -358,10 +358,10 @@ resource instances. Generally, the process works like this:
define what information will be gathered for a given resource
model.

#. A resource's `Cards <#cardmodel>`_ and are tied to specific
NodeGroups and define which input `Widgets <#widget>`_ will be used
to gather values for each Node in that NodeGroup. `Card Components
<#cardcomponent>`_ are used to render the cards in various contexts
#. A resource's :ref:`Cards <cardmodel>` and are tied to specific
NodeGroups and define which input :ref:`Widgets <widget>` will be used
to gather values for each Node in that NodeGroup. :ref:`Card Components
<card component>` are used to render the cards in various contexts
in the Arches UI.


Expand Down Expand Up @@ -431,7 +431,7 @@ Data Model Graph Visualization
Arches Models Only

.. image:: images/datamodel-arches-4.4.1-032119.svg
:target: _images/datamodel-arches-4.4.1-032119.svg
:target: ../_images/datamodel-arches-4.4.1-032119.svg

Full Data Model

Expand Down
4 changes: 2 additions & 2 deletions docs/designing-the-database.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Let's begin with a brief primer on some of the core concepts upon which Arches i

.. note:: Both **Resource Models** and **Branches** are sometimes referred to generically as "graphs". This is because their underlying architecture is a graph. However, as you'll see, they play completely different roles in Arches.

.. important:: The Arches Designer is used for altering the record-keeping structure of your database; it does not alter the physical `data model <data-model.html>`_.
.. important:: The Arches Designer is used for altering the record-keeping structure of your database; it does not alter the physical :ref:`data model`.

Arches Designer
===============
Expand All @@ -24,7 +24,7 @@ The Arches Designer is where you export, import, duplicate, modify, and create y

.. image:: images/arches-desinger.png

If you don't see any Resource Models listed in your Arches Designer, you may want to consider `loading a package <command-line-reference.html#loading-a-package-into-a-project>`_. Alternatively, you can directly import individual Resource Model files through **Add ...**.
If you don't see any Resource Models listed in your Arches Designer, you may want to consider :ref:`loading a package <loading a package into a project>`. Alternatively, you can directly import individual Resource Model files through **Add ...**.

To edit a Resource Model, click on it or click **Manage ...** > **Manage Graph** and you'll be brought to the Graph Designer.

Expand Down
16 changes: 8 additions & 8 deletions docs/exporting-v3-data.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Preparation - Exporting v3 Data

You must extract some content from your v3 deployment before beginning the migration process.

1. Export the v3 business data.
-------------------------------
Export the v3 business data
---------------------------

In your v3 command line run::

Expand All @@ -18,8 +18,8 @@ You will get a console update during the process, which could take a few minutes

Place these files somewhere easy to access.

2. Export the v3 reference data.
--------------------------------
Export the v3 reference data
----------------------------

In a browser, go to your v3 RDM and export the "Arches" scheme.

Expand All @@ -35,8 +35,8 @@ In a browser, go to your v3 RDM and export the "Arches" scheme.

**Dropdown Lists themselves are not migrated, they are recreated in v4 based on Top Concepts.**

3. Acquire the v3 resource graph ``_nodes.csv`` files.
------------------------------------------------------
Acquire the v3 resource graph _nodes.csv files
----------------------------------------------

You should be able to find these in your original ``source_data/resource_graphs`` directory, whose contents should be a ``_edges.csv`` and ``_nodes.csv`` for every resource graph in your database. We only want the ``_nodes.csv`` files.

Expand All @@ -50,8 +50,8 @@ Place these files somewhere easy to access.

Disregard this step, your ``_nodes.csv`` files will be provided for you.

4. Transfer all v3 uploaded media files.
----------------------------------------
Transfer all v3 uploaded media files
------------------------------------

You must move all of the media files that have been uploaded to your v3 deployment to your v4 project.

Expand Down
4 changes: 2 additions & 2 deletions docs/migrate-hip-app.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ Now go into your project's ``my_project/my_project/settings.py`` file and add th
2. Move your v3 data into the package.
--------------------------------------

Move ``v3fullexport.json`` and ``v3fullexport.relations`` from `v3 Preparation Step 1 <export-the-v3-business-data>`_ into ``v3data/business_data``.
Move ``v3fullexport.json`` and ``v3fullexport.relations`` from :ref:`v3 Preparation Step 1 <export the v3 business data>` into ``v3data/business_data``.

Move ``v3reference_data.xml`` from `v3 Preparation Step 2 <export-the-v3-reference-data>`_ into ``v3data/reference_data``.
Move ``v3reference_data.xml`` from :ref:`v3 Preparation Step 2 <export the v3 reference data>` into ``v3data/reference_data``.

Your package should now look like this::

Expand Down
8 changes: 4 additions & 4 deletions docs/migrate-other-app.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ This will create some new directories and content in your package::
3. Move your v3 data into the package.
--------------------------------------

Move ``v3fullexport.json``/``v3fullexport.relations`` from `v3 Preparation Step 1 <export-the-v3-business-data>`_ into ``v3data/business_data``.
Move ``v3fullexport.json``/``v3fullexport.relations`` from :ref:`v3 Preparation Step 2 <Export the v3 Business Data>` into ``v3data/business_data``.

Move ``v3reference_data.xml`` from `v3 Preparation Step 2 <export-the-v3-reference-data>`_ into ``v3data/reference_data``.
Move ``v3reference_data.xml`` from :ref:`v3 Preparation Step 2 <export the v3 reference data>` into ``v3data/reference_data``.

Move the ``_nodes.csv`` files from `v3 Preparation Step 3 <acquire-the-v3-resource-graph-nodes-csv-files>`_ into ``v3data/graph_data``.
Move the ``_nodes.csv`` files from :ref:`v3 Preparation Step 3 <acquire the v3 resource graph _nodes.csv files>` into ``v3data/graph_data``.

Your package should now look like this::

Expand Down Expand Up @@ -121,7 +121,7 @@ When it comes to node datatypes, the translation from v3 to v4 is pretty straigh

.. seealso::

Refer to `Designing the Database <designing-the-database.html>`_ for help on this task. Within the Arches Designer itself, click |help-btn| for detailed help on each page.
Refer to :ref:`Designing the Database` for help on this task. Within the Arches Designer itself, click |help-btn| for detailed help on each page.

----

Expand Down
2 changes: 1 addition & 1 deletion docs/requirements-and-dependencies.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To begin development or make a test installation of Arches, you will need the fo

+ **4GB memory (RAM)**
+ This recommendation is based on the fact that ElasticSearch requires 2GB to run, and as per `official ElasticSearch documentation <https://www.elastic.co/guide/en/elasticsearch/guide/current/heap-sizing.html#_give_less_than_half_your_memory_to_lucene>`_ no more than half of your system's memory should be dedicated to ElasticSearch.
+ In development, it's possible to force ElasticSearch to run with only 1GB of memory, see `Note 1 <arches-and-elasticsearch.html#notes>`_
+ In development, it's possible to force ElasticSearch to run with only 1GB of memory, see :ref:`Running Elasticsearch`.
+ In production, you may want to increase your memory, and allow ElasticSearch to use `up to 32GB of memory <https://www.elastic.co/guide/en/elasticsearch/guide/current/heap-sizing.html#compressed_oops>`_.

Software Dependencies
Expand Down
2 changes: 1 addition & 1 deletion docs/v3-to-v4-migration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Before migrating data, you'll need to install Arches 4 and make a new project. Y

.. seealso::

Refer to `Installation <installation.html>`_ and `Projects and Packages <projects-and-packages.html>`_.
Refer to :ref:`Installation` and :ref:`Projects and Packages`.

Before moving on, you should be able to run the Django devserver from your project, and view it in a browser at http://localhost:8000.

Expand Down

0 comments on commit 5b4e8f7

Please sign in to comment.