more progress on docs

lincbrain · Oct 25, 2024 · 6c717d6 · 6c717d6
1 parent 7dea59b
commit 6c717d6
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/docs/59_getting_started_replicating_dandi.md b/docs/59_getting_started_replicating_dandi.md
@@ -1,2 +1,4 @@
 The series of docs in this directory define how to create your own DANDI ecosystem.
 
+This series of documents explains how to create a new instance of the DANDI project (i.e. a clone of the entire DANDI ecosystem). It is suggested that you briefly read through each of the
+documents in this guide before starting.
diff --git a/docs/60_initialize_vendors.md b/docs/60_initialize_vendors.md
@@ -1,8 +1,5 @@
 # Initialize Vendor Accounts
 
-This series of documents explains how to create a new instance of the DANDI project (i.e. a clone of the entire DANDI ecosystem). It is suggested that you briefly read through each of the
-documents in this guide before starting.
-
 The DANDI ecosystem relies on vendor services to operate.  So first you will need to set up accounts with the following vendors:
 
 • **Heroku**

diff --git a/docs/62_dandi_cli.md b/docs/62_dandi_cli.md
@@ -1,6 +1,4 @@
-# Work In Progress -- This page should not be referenced until further abstraction is handled for the DANDI CLI tool
-
-For data management (predominately `upload` and `download` of data 
+For data management (predominately `upload`, `download` and `validation` of data 
 to/from DANDI), a local CLI (command line interface) is used.
 
 **Note: please make sure [you have set up your PyPI account](..60_initialize_vendors/##pypi).**
@@ -31,10 +29,14 @@ known_instances = {
 }
 ```
 
-## Connecting to PyPI
+## Handling Versioning
+
+DANDI CLI leverages a tool called [versioneer](https://pypi.org/project/versioneer/) for semantic versioning in PyPI.
+
+Upon merging of a PR into `main`, if a given GitHub label is attached to the PR (`major`, `minor` or `patch` specifically)
+`versioneer` will generate a human-readable CHANGELOG entry, and then push to PyPI the proper new semantic version.
 
 
-## Handling Versioning
 
 
 

diff --git a/docs/64_dandi_archive.md b/docs/64_dandi_archive.md
@@ -1,5 +1,3 @@
-# Work In Progress
-
 This step assumes that you have completed all steps in: [Initialize Vendors](../60_initialize_vendors) & [DANDI Infrastructure](../63_dandi_infrastructure)
 
 ## Initial Steps
@@ -126,7 +124,7 @@ style="width: 60%; height: auto; display: block; margin-left: auto;  margin-righ
 
 Other than the output of the CI/CD workflow, you can observe the status of the new release via your Heroku app dashboard.
 
-- **Production**:  by default, releases are managed via "tags" applied to given PRs merged into main with the label of "released"
+- **Production**:  by default, releases are managed via "tags" applied to given PRs merged into main with the label of "release"
 
 <br/><br/>
 <img

diff --git a/docs/65_dandi_hub.md b/docs/65_dandi_hub.md
@@ -1,5 +1,6 @@
-# Work In Progress
+The DANDI ecosystem includes a self-hosted Jupyter notebook service. This service is orchestrated on a Kubernetes (k8s) cluster
+that provides different instance types of users to efficiently interact with data in the DANDI Archive.
 
-## DO_EKS Setup
-
-## Observability and Monitoring
+[Proceed to the following README](https://github.com/dandi/dandi-hub/blob/main/README.md#dandihub) to see how you can
+set up your own DANDI Hub -- **Note: it is important that your k8s cluster is in the same region
+as your data**