Introduction

Overview

What is Arches?

Who is Arches for?

Documentation Overview

Contributing To Arches

Needs a once-over from GCI, and “Version History”
Could add a link to the Glossary on the archesproject website?

Arches Release Process

Feature Releases

Patch Releases

Release Support

Release Support section needs update, and perhaps could be merged with “Version History” in above section? (Dennis/Annabel?)
Also, consider this page: https://github.com/archesproject/arches/wiki/v4-General-Development-Timeline. Remove it??

Installation and Configuration

#rename Installing

Requirements/Dependencies

System Requirements

Software Dependencies

#revise clarify which dependencies are installed via the install scripts #112
#add celery broker section from Task Management (with “if you plan to…” just like the Arches Collector/couchdb note.
#revise #simple fix broken link in celery broker section #201
#add installing pip on Ubuntu 18.04 #166
#add section about how to properly prepare the Postgres database #115
#revise CouchDB installation #165

Installing Core Arches

#add message box about creating/using virtual envs
#111
#revise (condense), and move “quick start” settings here

Installation

#add Yarn permissions and packages #167
General Troubleshooting
#revise virtualenv instructions to use syntax for python3 #184

General Troubleshooting

Configuring Settings

#move to Configuring

Quick Start

#move this section (in spirit, not verbatim) to the Installing section

Arches Production Deployment

#remove “Permissions Settings” section (it’s redundant, covered in Administering Arches, Designing the Database content)
#move the rest of this section to new Running Arches in Production section

Full Explanation of the System Settings UI

Projects

#add and move content here from old packages section

Projects and Packages

#rename to Packages

Projects

Packages

#revise structure of package as documented in https://github.com/archesproject/arches/issues/2822 #208
#add information on reports, card components, plugins and ontologies #206
#add an explanation of when it is appropriate to place a package within a project and when a developer might want to keep the package external #206
#revise load package command for 5.1 #214

Task Management

#move the rest of the content (all but Dependencies) to new “Task Management” section in developing with Arches. (perhaps point to this section in the above Software Dependencies entry)

note: decided to leave the small paragraph about dependencies here as well

Dependencies

#move this broker section to end of Software Dependencies

Configuration

Adding Tasks to Your Project

Running Celery

Configuring

#add

Administering

#add

Managing Permissions

#add

this section needs to provide an overview of all the various places that permissions can be modified

User Permissions in the Django UI

#add #98

Resource Datatype and Card Permissions

Resource Instance Permissions

#add #218

Using Arches

Designing the Database

#move to Administering

Arches Database Theory

#add Arches Uniqueness Constraint Functionality #105
#add description of existing datatypes #76
#add section on related resources with warning about deprecation #162 (such a warning is in Creating Resources too)

Arches Designer

#add note on branch versioning #117

Graph Designer

#revise #simple grammatical mistake under Related Resources Map Component #177

Ontologies in Arches

#move to Administering

Loading an Ontology

#revise #89

Loading a custom ontology

Enforcing ontology rules

Creating Resources

#rename Creating and Editing Resources

Resource Manager

Resource Editor

#add notification that resource relationship schema in v4 is being deprecated in favor of using the resource instance datatype #162

Deleting Resources

#add #224 https://github.com/archesproject/arches-docs/issues/224

Searching

#add #225 also see in-app help
#185 make sure that question in this ticket is addressed.

Managing Map Layers

#move to Administering

Different Types of Layers

Reference Data Manager (RDM)

#move to Administering

Concept Schemes

#add section on Sharing Concept Schemes #10

Arches Collector Manager

#move to Administering

What Are Arches Collector Projects?

Arches Collector Manager Overview

Creating Projects in the Arches Collector Manager

Creating an Offline Basemap

Using Arches Collector

Introduction to Arches Collector

#add links to the app stores #109 #simple

Arches Collector Workflow

Connect to an Arches Instance

Download a Project

Navigating a Project

Creating Records

Editing Records

Syncing Data

#revise #220

Developing with Arches

Adding New Javascript Dependencies

#add
#61

Additional Configuration

#remove once all content has been moved

Password Validators

#move to Configuring

Time Wheel Configuration

#move to Configuring

Arches and Elasticsearch

Installing and Running Elasticsearch

Using the Kibana Dashboard

#add
#217

Reindexing The Database

#revise with new command #221

Using Multiple Nodes

Adding a Custom Index

API

General Notes

Authentication

#move Registering an application to Configuring #114

Concepts

Resources

Activity Stream

Mobile Projects

GeoJSON

Command Line Reference

Installation Commands

ElasticSearch Management

#revise Update reindex command #221
Import Commands

Export Commands

Other Data Management Commands

Ontology Commands

Managing Functions, DataTypes, Widgets, and Card

Components

Creating Map Layers

Other Useful Django Commands
#add #213 save_system_settings

Creating a Development Environment

#revise #simple typo on first sentence “recommedation”

Setting Everything Up

#revise #168

Running Tests

#add #190

Creating New Functions, Widgets, Card Components, DataTypes, and Plugins

#rename “Creating Custom Components”

About Custom Components

#add this new content which gives a general explanation of the structure behind all of the following types of extensions
- look through all existing content here and pull relevant stuff into this new section

note: location/section title added, but content still needs to be reworked as described above

Functions

Widgets

DataTypes

Card Components

Plugins

#add
description of plugin architecture #129 (this is close to finished already actually).

#add
requested by Adam via Forum #222

Creating New Map Layers

MapBox Layers

#revise for v5 defining selectable layers #174

Creating Reports

#add
#205

Creating Workflows

#add
#215

Data Model

Resource Model Overview

Controllers

Graph Definition

Ontologies

RDM Models

Resource Data

UI Component Models

#add Cardview Model #203
#add Tileview Model #202

Data Model Graph Visualization

Integrating Arches with ArcGIS

#add
#216

Localizing Arches

#add
#210

Migrating Data from v3 to v4

#rename to Migrating Data from v3

Exporting Your Data From v3

Migrating Your Data

Resource Import/Export

Importing Data

#add resource-instance[-list] datatype fields #127

Importing a CSV

#revise #simple “Resource ID”, should be “ResourceID” #128
#add resource-instance[-list] datatype fields
#127
#revise clarify the limitations of csv and groupings #118

Shapefile Import

JSON Import

Importing Resource Relations

Exporting Arches Data

Settings - Beyond the UI

#move to Configuring

Using Arches Offline

#add if this is even possible in v5?
#12

Running Arches in Production

#add
#11

Serving Arches with Apache (moved from Reference)

#add moved here from Reference

Setup Apache

#add SSL deployment #110

Handling Static Files

#revise
#simple two minor errors #119

Handling Uploaded Media

#add #125

Supervisord

#add moved here from Reference

Backing up the Database

#add
#132

Using AWS S3

#add migrated from wiki

Migrating a local app to EC2

#add migrate from wiki: (https://github.com/archesproject/arches/wiki/Migrating-a-Local-App-to-AWS-EC2)

Reference

#remove this section, once all contents have been handled

Appendix A: Arches HIP

#move to the readme file of this repo: https://github.com/archesproject/arches-example-pkg

note: PR made: https://github.com/archesproject/arches-example-pkg/pull/1

Resource Models

Branches

Appendix B: Glossary

#remove this section in favor of the Glossary on archesproject.org

Glossary

Appendix C: Serving Arches with Apache

#move to Running Arches in Production section

Appendix D: Setting Up Supervisord For Celery

#move to new Arches in Production section

Appendix E: Managing and Hosting IIIF Servers

#move to Developing #197