Merge pull request #118 from Seshat-Global-History-Databank/blank-doc…

…s-pages Add blank docs pages
Seshat-Global-History-Databank · Oct 8, 2024 · 9402fa5 · 9402fa5
2 parents 69fce65 + 4bb4ff4
commit 9402fa5
Show file tree

Hide file tree

Showing 20 changed files with 170 additions and 33 deletions.
diff --git a/docs/source/admin/backup.rst b/docs/source/admin/backup.rst
@@ -0,0 +1,4 @@
+Database backups
+===============
+
+...
diff --git a/docs/source/admin/bulk_updates.rst b/docs/source/admin/bulk_updates.rst
@@ -0,0 +1,4 @@
+Adding new datasets to the Seshat database
+========================================
+
+...
diff --git a/docs/source/admin/django.rst b/docs/source/admin/django.rst
@@ -0,0 +1,4 @@
+Using Django in Seshat
+======================
+
+...
diff --git a/docs/source/admin/index.rst b/docs/source/admin/index.rst
@@ -1,14 +1,26 @@
 Seshat Databank Admin
 ============
 
+This section of the documentation is for the Seshat Databank Admins: members of the Seshat team responsible for the maintenance and development of the Seshat codebase, database and website.
+
+If you are new to the Seshat project, you should review these pages, in particular the Getting Started section of the Developers Guide.
+
+You may also wish to review the `team <../team.rst>`_ page, which includes a help section, to see who on the Seshat team can help you with various tasks.
+
 .. toctree::
    :maxdepth: 3
 
-   setup/index
    developers-guide
+   repo_structure
+   django
+   bulk_updates
+   backup
+   schema
    testing
    api/index
    websites
+   setup/index
+
 
 
 
diff --git a/docs/source/admin/repo_structure.rst b/docs/source/admin/repo_structure.rst
@@ -0,0 +1,4 @@
+Seshat Github repo structure
+============================
+
+...
diff --git a/docs/source/admin/schema.rst b/docs/source/admin/schema.rst
@@ -0,0 +1,4 @@
+Database schema map
+===================
+
+...
diff --git a/docs/source/admin/testing.rst b/docs/source/admin/testing.rst
@@ -40,3 +40,8 @@ To set up pushing the docker image using the GH action workflow, I first did the
 
 - Generated a new GitHub token with the ``read:packages`` and ``write:packages`` scopes. Under my ``Settings > Developer settings > Personal access tokens`` (classic token).
 - Stored the GitHub token as a secret in the Seshat GitHub repository, ``Settings > Secrets``, named ``GH_TOKEN``.
+
+Adding new tests
+----------------
+
+*TODO: Add instructions for adding new tests.*
diff --git a/docs/source/contact.rst b/docs/source/contact.rst
diff --git a/docs/source/expert/index.rst b/docs/source/expert/index.rst
@@ -1,7 +1,19 @@
 Seshat Expert
 ============
 
-TODO: Add content here
+This page includes help for our Seshat Experts: collaborators with the necessary expertise and permission to approve or reject changes to the Seshat data.
+
+
+Creating a login on the Seshat website
+---------------------------------------
+
+
+Making and approving data edits
+-------------------------------
+
+
+Discussing data edits via private comments
+--------------------------------------------
 
 
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,27 +10,20 @@ On this site you will find documentation for the Seshat project, such as how-to
 
 The documentation is divided into sections based on the role of the reader, which match the access level of your account on the Seshat website. These roles are defined as follows:
 
-1. Seshat Databank Admin: A member of the Seshat team responsible for the maintenance and development of the Seshat codebase.
-2. Research Assistant: A researcher contributing to the Seshat data as part of an ongoing Seshat affiliated project.
+1. Seshat Databank Admin: A member of the Seshat team responsible for the maintenance and development of the Seshat codebase, database and website.
+2. Researcher: Any researcher contributing to, or consuming, the Seshat data as part of an ongoing Seshat affiliated project.
 3. Seshat Expert: A collaborator with the necessary expertise and permission to approve or reject changes to the Seshat data.
 4. Public User: An academic or other interested party who has created an account on the Seshat website to suggest data edits.
 
 .. toctree::
    :maxdepth: 2
 
    admin/index
-   research_assistant/index
+   researcher/index
    expert/index
    public_user/index
+   team
+   resources
    api/index
    code-of-conduct
-   contact
 
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/source/public_user/index.rst b/docs/source/public_user/index.rst
@@ -1,7 +1,15 @@
 Public User
 ============
 
-TODO: Add content here
+This page includes help for Seshat Public Users: academics or other interested parties who wish to suggest data edits.
+
+
+Creating a login on the Seshat website
+---------------------------------------
+
+
+Suggesting data edits
+---------------------
 
 
 
diff --git a/docs/source/research_assistant/index.rst b/docs/source/research_assistant/index.rst
diff --git a/.../source/research_assistant/cliopatria.rst → docs/source/researcher/cliopatria.rst b/.../source/research_assistant/cliopatria.rst → docs/source/researcher/cliopatria.rst
@@ -1,5 +1,5 @@
-Cliopatria 
-=========
+How to edit the Cliopatria borders dataset
+===========================================
 
 Cliopatria is a comprehensive open-source geospatial dataset of worldwide states, political groups, events, and rulers from 3400BCE to 2024CE.
 It is part of the Seshat Global History Databank project.

diff --git a/docs/source/researcher/datasets.rst b/docs/source/researcher/datasets.rst
@@ -0,0 +1,13 @@
+Seshat datasets
+===============
+
+Data downloads
+--------------
+
+
+Data cleaning code
+-----------------
+
+
+Making your dataset available to others
+---------------------------------------
diff --git a/docs/source/researcher/getting_started.rst b/docs/source/researcher/getting_started.rst
@@ -0,0 +1,14 @@
+Getting started with Seshat data
+=================================
+
+
+Creating a login on the Seshat website
+---------------------------------------
+
+
+Loading Seshat data in Python via the Seshat API
+------------------------------------------------
+
+
+Working with the Cliopatria borders dataset
+--------------------------------------------
diff --git a/docs/source/researcher/index.rst b/docs/source/researcher/index.rst
@@ -0,0 +1,22 @@
+Researcher
+============
+
+These pages are useful for any researcher contributing to, or consuming, the Seshat data as part of an ongoing Seshat affiliated project.
+
+A great place to start for someone new on the project is the `Getting started with Seshat data <getting_started>`_ page, which contains example notebooks for loading Seshat data in Python.
+
+You may also wish to review the `team <../team.rst>`_ page, which includes a help section, to see who on the Seshat team can help you with various tasks.
+
+.. toctree::
+   :maxdepth: 3
+
+   getting_started
+   datasets
+   cliopatria
+   projects
+   website
+
+See also the `API documentation <../api/index.rst>`_.
+
+
+
diff --git a/docs/source/researcher/projects.rst b/docs/source/researcher/projects.rst
@@ -0,0 +1,4 @@
+Seshat projects
+===============
+
+...
diff --git a/docs/source/researcher/website.rst b/docs/source/researcher/website.rst
@@ -0,0 +1,10 @@
+How to use the Seshat website to make and discuss data edits
+=============================================================
+
+
+Making and approving data edits
+-------------------------------
+
+
+Discussing data edits via private comments
+--------------------------------------------
diff --git a/docs/source/resources.rst b/docs/source/resources.rst
@@ -0,0 +1,26 @@
+List of Seshat project resources
+===============================
+
+
+Papers
+-----
+
+
+GitHub
+------
+
+
+Zenodo
+------
+
+
+Websites
+--------
+
+
+Codebooks
+---------
+
+
+Shared drives
+-------------
diff --git a/docs/source/team.rst b/docs/source/team.rst
@@ -0,0 +1,14 @@
+Team
+====
+
+
+Contact
+-------
+
+
+Who can help me if...
+----
+
+
+Communication channels
+----------------------