Merge branch 'master' into create-account-more-info

# Conflicts: # docs/16_account.md
dandi · Jul 9, 2024 · 4eeb555 · 4eeb555
2 parents 4cfef62 + 15a34c2
commit 4eeb555
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 15 deletions.
diff --git a/docs/13_upload.md b/docs/13_upload.md
@@ -109,21 +109,45 @@ There are two options for storing your DANDI access credentials.
         and a plaintext (unencrypted) keyfile.
 
     - Specifying the `keyring` backend
-        - You can set the backend the `keyring` library uses either by setting the
-          `PYTHON_KEYRING_BACKEND` environment variable or by filling in the `keyring`
-          library's [configuration file](https://github.com/jaraco/keyring#configuring).
-        - IDs for the available backends can be listed by running `keyring --list`.
-        - If no backend is specified in this way, the library will use the available
-          backend with the highest priority.
-        - If the DANDI CLI encounters an error while attempting to fetch the API key
-          from the default keyring backend, it will fall back to using an encrypted
-          keyfile (the `keyrings.alt.file.EncryptedKeyring` backend).  If the keyfile
-          does not already exist, the CLI will ask you for confirmation; if you answer
-          "yes," the `keyring` configuration file (if it does not already exist; see
-          above) will be configured to use `EncryptedKeyring` as the default backend.
-          If you answer "no," the CLI will exit with an error, and you must store the
+        - You can set the backend the `keyring` library uses either by setting
+          the `PYTHON_KEYRING_BACKEND` environment variable or by filling in
+          the `keyring` library's [configuration
+          file](https://github.com/jaraco/keyring#configuring).
+
+        - IDs for the available backends can be listed by running `keyring
+          --list`.
+
+        - If no backend is specified in this way, the library will use the
+          available backend with the highest priority.
+
+        - If the DANDI CLI encounters an error while attempting to fetch the
+          API key from the default keyring backend, it will fall back to using
+          an encrypted keyfile (the `keyrings.alt.file.EncryptedKeyring`
+          backend).  If the keyfile does not already exist, the CLI will ask
+          you for confirmation; if you answer "yes," the `keyring`
+          configuration file (if it does not already exist; see above) will be
+          configured to use `EncryptedKeyring` as the default backend.  If you
+          answer "no," the CLI will exit with an error, and you must store the
           API key somewhere accessible to the CLI on your own.
 
+            - Unless a different location is set via the `keyring`
+              configuration file, the encrypted keyfile will be located at the
+              following path:
+
+                - On Linux and macOS, if the `XDG_DATA_HOME` environment
+                  variable is set to a nonempty string, the keyfile will be at
+                  `$XDG_DATA_HOME/python_keyring/crypted_pass.cfg`; otherwise,
+                  it will be at
+                  `~/.local/share/python_keyring/crypted_pass.cfg`.
+
+                - On Windows, if the `LOCALAPPDATA` environment variable is
+                  set, the keyfile will be at `%LOCALAPPDATA%\Python
+                  Keyring\crypted_pass.cfg`; otherwise, if the `ProgramData`
+                  environment variable is set, the keyfile will be at
+                  `%ProgramData%\Python Keyring\crypted_pass.cfg`; otherwise,
+                  it will be at `Python Keyring\crypted_pass.cfg` within the
+                  current directory.
+
     - Storing the API key with `keyring`
         1. You can store your API key where the `keyring` library can find it by using
           the `keyring` program: Run `keyring set dandi-api-dandi key` and enter the

diff --git a/docs/16_account.md b/docs/16_account.md
@@ -19,9 +19,9 @@ If your registration is denied:
 ## How to Register for a DANDI Account
 
 1. **Create a GitHub Account**: If not already a GitHub user, [sign up here](https://github.com/).
-2. **Register on DANDI**: Navigate to the DANDI homepage and click the `LOG IN WITH GITHUB` button to register using your GitHub account.
+2. **Register on DANDI**: Navigate to the [DANDI homepage](https://dandiarchive.org) and click the `LOG IN WITH GITHUB` button to register using your GitHub account.
 3. **Confirmation of Review**: Post-registration, you will receive an email confirming that your account is under review. Your request will be reviewed within 24 hours.
    - **Note**: Reviews may extend beyond 24 hours for new GitHub accounts or non-.edu email addresses, particularly if the registration does not describe immediate plans to contribute data.
 4. **Accessing DANDI**: Upon approval, access DANDI by logging in through the `LOG IN WITH GITHUB` button.
 
-For support or further inquiries, reach out to [help@dandiarchive.org](mailto:help@dandiarchive.org).
+For support or further inquiries, reach out to [help@dandiarchive.org](mailto:help@dandiarchive.org).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -39,6 +39,9 @@ nav:
     - REST API Swagger: https://api.dandiarchive.org/swagger
     - REST API Redoc: https://api.dandiarchive.org/redoc
   - DANDI Hub: "50_hub.md"
+  - Health Status:
+    - Dandisets: https://github.com/dandi/dandisets-healthstatus
+    - Services: https://www.dandiarchive.org/upptime
   - Terms and Policies:
       - Terms: "about/terms.md"
       - Policies: "about/policies.md"