diff --git a/docs/arches-and-elasticsearch.txt b/docs/arches-and-elasticsearch.txt index b3f6b727..34ea1a99 100644 --- a/docs/arches-and-elasticsearch.txt +++ b/docs/arches-and-elasticsearch.txt @@ -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 `_). +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:: diff --git a/docs/data-model.txt b/docs/data-model.txt index c33c29ad..1b84f255 100644 --- a/docs/data-model.txt +++ b/docs/data-model.txt @@ -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 `, :ref:`Nodes +`, and :ref:`Edges ` 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 `. In the Arches data model, Nodes represent their graph data structure namesakes, sometimes called `vertices`. A Node does the work of @@ -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 `, 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 @@ -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 ` and are tied to specific + NodeGroups and define which input :ref:`Widgets ` will be used + to gather values for each Node in that NodeGroup. :ref:`Card Components + ` are used to render the cards in various contexts in the Arches UI. @@ -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 diff --git a/docs/designing-the-database.txt b/docs/designing-the-database.txt index 4347fd7d..978e3f54 100644 --- a/docs/designing-the-database.txt +++ b/docs/designing-the-database.txt @@ -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 `_. +.. 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 =============== @@ -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 `_. 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 `. 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. diff --git a/docs/exporting-v3-data.txt b/docs/exporting-v3-data.txt index 6610d8d5..1207a7d4 100644 --- a/docs/exporting-v3-data.txt +++ b/docs/exporting-v3-data.txt @@ -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:: @@ -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. @@ -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. @@ -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. diff --git a/docs/migrate-hip-app.txt b/docs/migrate-hip-app.txt index 9f7662c7..b79e1c2e 100644 --- a/docs/migrate-hip-app.txt +++ b/docs/migrate-hip-app.txt @@ -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 `_ into ``v3data/business_data``. +Move ``v3fullexport.json`` and ``v3fullexport.relations`` from :ref:`v3 Preparation Step 1 ` into ``v3data/business_data``. -Move ``v3reference_data.xml`` from `v3 Preparation Step 2 `_ into ``v3data/reference_data``. +Move ``v3reference_data.xml`` from :ref:`v3 Preparation Step 2 ` into ``v3data/reference_data``. Your package should now look like this:: diff --git a/docs/migrate-other-app.txt b/docs/migrate-other-app.txt index 158cca44..c503b6b2 100644 --- a/docs/migrate-other-app.txt +++ b/docs/migrate-other-app.txt @@ -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 `_ into ``v3data/business_data``. +Move ``v3fullexport.json``/``v3fullexport.relations`` from :ref:`v3 Preparation Step 2 ` into ``v3data/business_data``. -Move ``v3reference_data.xml`` from `v3 Preparation Step 2 `_ into ``v3data/reference_data``. +Move ``v3reference_data.xml`` from :ref:`v3 Preparation Step 2 ` into ``v3data/reference_data``. -Move the ``_nodes.csv`` files from `v3 Preparation Step 3 `_ into ``v3data/graph_data``. +Move the ``_nodes.csv`` files from :ref:`v3 Preparation Step 3 ` into ``v3data/graph_data``. Your package should now look like this:: @@ -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 `_ 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. ---- diff --git a/docs/requirements-and-dependencies.txt b/docs/requirements-and-dependencies.txt index 4c637923..68f9bb02 100644 --- a/docs/requirements-and-dependencies.txt +++ b/docs/requirements-and-dependencies.txt @@ -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 `_ 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 `_ + + 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 `_. Software Dependencies diff --git a/docs/v3-to-v4-migration.txt b/docs/v3-to-v4-migration.txt index 88185228..c3688734 100644 --- a/docs/v3-to-v4-migration.txt +++ b/docs/v3-to-v4-migration.txt @@ -12,7 +12,7 @@ Before migrating data, you'll need to install Arches 4 and make a new project. Y .. seealso:: - Refer to `Installation `_ and `Projects and Packages `_. + 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.