Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ User Guide
pages/querying_existing_db/index
pages/ingesting/getting_started_ingesting
pages/modifying/index
pages/make_new_db/getting_started_new_database
pages/make_new_db/index
pages/template_repo/index
pages/template_schema/template_schema
pages/making_private_version
Expand Down
24 changes: 24 additions & 0 deletions docs/pages/make_new_db/create_database.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Create a New Database
=======================

Start with the template schema which is defined by the
schema YAML file located at ``schema/schema.yaml``.

This file needs to be modified to suit your use case.
e.g., add or rename tables, columns, etc.

#. :doc:`Modify the schema YAML file <../modifying/index>`
to suit your use case.

* We highly recommend using an AI coding assistant
(like GitHub Copilot) when modifying this file.

#. Generate a new entity relationship diagram (ERD)
and documentation pages for your schema.

* To make a new ERD, run ``scripts/build_schema_docs.py``.
This generates a PNG file in the ``docs/figures/`` directory.

* To make new documentation pages, run ``scripts/build_schema_docs.py``.
This generates a new set of Markdown files
in the ``docs/schema/`` directory.
35 changes: 0 additions & 35 deletions docs/pages/make_new_db/getting_started_new_database.rst

This file was deleted.

13 changes: 13 additions & 0 deletions docs/pages/make_new_db/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Making a New Database
=====================

.. toctree::
:glob:
:maxdepth: 1

new_repo
create_database
ingest_data



15 changes: 15 additions & 0 deletions docs/pages/make_new_db/ingest_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Ingest Data into New Database
=============================

There are many ways to ingest data into the database:

Data that fits into the template schema
can be ingested into the database using the astrodb_utils functions.


#. Delete template data

#. Ingest data by modifying the JSON files by hand
(in the ``data/`` directory) or by using ``astrodb_utils`` functions.

#. Modify tests
10 changes: 10 additions & 0 deletions docs/pages/make_new_db/new_repo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Make a new GitHub Repository
============================

#. Make a new GitHub repository using the `astrodb-template-db <https://github.com/astrodbtoolkit/astrodb-template-db>`_ template repository.

#. Update the ``README.md`` file with your database name and description.

* Please retain the credit line to the AstroDB Toolkit.

#. Update the ``LICENSE`` file with your license of choice.