Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft: Updates to handbook for dandi-clone #8

Closed
wants to merge 81 commits into from
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
9402f8e
add docs on the hub
bendichter Sep 7, 2023
e67b2cc
Update docs/50_hub.md
bendichter Sep 7, 2023
f03a22f
remove specific submission instructions, since they are now a PR on t…
bendichter Sep 7, 2023
e75658b
Merge remote-tracking branch 'origin/hub_docs' into hub_docs
bendichter Sep 7, 2023
c4a3d8c
Added dandi-architecture.drawio
kabilar Nov 7, 2023
0f35977
Add API docs
kabilar Nov 29, 2023
2738036
Update text
kabilar Nov 29, 2023
568e250
Remove empty test file
kabilar Nov 29, 2023
0706146
Merge pull request #102 from kabilar/dandi
yarikoptic Nov 30, 2023
09f9b1b
Add search plugin
kabilar Dec 1, 2023
1473cce
Provide draft readme for dandi ecosystem replication
Dec 1, 2023
a10f216
cleanup for dandi pr
Dec 1, 2023
7fbaf32
cleanup x2
Dec 1, 2023
b14568a
whoops
Dec 1, 2023
8a4b9ff
cleanup x3
Dec 1, 2023
14ebac9
Merge pull request #103 from kabilar/dandi
yarikoptic Dec 14, 2023
d1db03d
Update docs/50_hub.md
bendichter Dec 18, 2023
7daa32e
Update docs/50_hub.md
bendichter Dec 18, 2023
9756ff3
Update docs/50_hub.md
bendichter Dec 18, 2023
9333207
style - DANDI Archive
bendichter Dec 18, 2023
bafa740
Merge pull request #107 from dandi/style-dandi-archive
yarikoptic Dec 18, 2023
551cbac
Update docs/50_hub.md
bendichter Dec 23, 2023
e4ea76c
Update docs/50_hub.md
bendichter Dec 23, 2023
d50b480
Update docs/50_hub.md
bendichter Dec 23, 2023
7a67a14
Merge branch 'master' into hub_docs
bendichter Dec 23, 2023
ca4f064
Update docs/50_hub.md
bendichter Jan 9, 2024
35917e1
Update docs/50_hub.md
bendichter Jan 9, 2024
9a7fa5c
Merge pull request #95 from dandi/hub_docs
bendichter Jan 9, 2024
f4a03f4
Update publish page
kabilar Jan 18, 2024
47ce471
Minor requirements bump to have mkdocs work
Jan 18, 2024
fc480dc
Remix the content a bit
waxlamp Feb 22, 2024
5a88a81
Update homepage link for the logo in the header
kabilar Feb 22, 2024
ed0c352
Update DOI for DANDI CLI to cite all versions
kabilar Feb 22, 2024
d9f6773
Add markdown extension for auto-linking http links
kabilar Feb 22, 2024
87c8490
Remove markdown formatted links
kabilar Feb 22, 2024
a71bc1d
Add `Create a DANDI Account` page
kabilar Feb 22, 2024
c4ef796
Update text
kabilar Feb 22, 2024
b197b7e
Remove markdown formatted links
kabilar Feb 22, 2024
5237a4a
Add social icons to footer
kabilar Feb 22, 2024
e0beb19
Add headings for each option to store access credentials
kabilar Feb 22, 2024
a66d91b
Revert imperative-style change
kabilar Feb 22, 2024
a62a59f
Merge pull request #114 from kabilar/doi
yarikoptic Feb 22, 2024
8b53ba0
Merge pull request #117 from kabilar/social-icons
yarikoptic Feb 22, 2024
8ce50ad
Merge pull request #115 from kabilar/magiclink
yarikoptic Feb 22, 2024
dc55dd2
Merge branch 'master' into homepage-link
yarikoptic Feb 22, 2024
bc39abb
Merge pull request #113 from kabilar/homepage-link
yarikoptic Feb 22, 2024
e955b29
Add GitHub Action to test the build of mkdocs site
kabilar Feb 23, 2024
ced89c2
Update Python versoin
kabilar Feb 23, 2024
02974ca
Rename file
kabilar Feb 23, 2024
ed68af8
Revert actions/checkout version
kabilar Feb 23, 2024
668cc67
Pin `mkdocs-material` version to force install later version
kabilar Feb 23, 2024
bb28a8c
Merge pull request #121 from kabilar/update-actions
yarikoptic Feb 23, 2024
9672a41
Update docs/14_publish.md
kabilar Feb 23, 2024
51114fc
Update docs/14_publish.md
kabilar Feb 23, 2024
4f4b576
Merge pull request #111 from kabilar/zarr
yarikoptic Feb 23, 2024
9f0d2ca
Update docs/16_account.md
kabilar Feb 23, 2024
d3bb3b6
Update docs/16_account.md
kabilar Feb 23, 2024
294ee22
Update docs/16_account.md
kabilar Feb 23, 2024
4e29b82
Update docs/16_account.md
kabilar Feb 23, 2024
f55eec6
Change order of instructions
kabilar Feb 24, 2024
f8da6cc
Fix indentation
kabilar Feb 24, 2024
0397d05
Fix numbering
kabilar Feb 24, 2024
989295c
Reorder instructions
kabilar Feb 24, 2024
13c833f
Update title
kabilar Feb 24, 2024
9393536
Fix formatting and syntax
kabilar Feb 24, 2024
b607838
State explicitly that our current maximal length of the path in dandi…
yarikoptic Mar 7, 2024
761e460
Move tech limitations to "Using DANDI" section from the policy
yarikoptic Mar 7, 2024
abbe4ca
Merge pull request #124 from dandi/max-path
yarikoptic Mar 7, 2024
352ba93
Add information on SEntry and heroku logs
yarikoptic Mar 26, 2024
12e3097
Add on CI jobs logging and monitoring (upptime)
yarikoptic Mar 26, 2024
e8feeb8
Merge pull request #122 from kabilar/credentials
yarikoptic Mar 27, 2024
6624c05
Merge pull request #116 from kabilar/create-account
yarikoptic Mar 27, 2024
88a971a
Apply a few grammar fixes
waxlamp Mar 27, 2024
7ca8902
Merge pull request #126 from dandi/enh-logs
waxlamp Mar 27, 2024
8eb6002
Document the possibility of extra dandihub images in the user docs
asmacdo Mar 27, 2024
d662f47
accept Kabi suggestion
asmacdo Mar 27, 2024
1e45f18
Merge pull request #127 from asmacdo/add-custom-image-doc
kabilar Mar 28, 2024
51da59a
Merge pull request #120 from kabilar/test-build
yarikoptic Mar 29, 2024
75fb959
more organization
Apr 8, 2024
1ecdafa
temp push
Apr 11, 2024
8d3ad40
merge main into ak-dandi-init
Apr 11, 2024
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
11 changes: 9 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ copyright: "CC-BY 4.0"
use_directory_urls: true
site_url: https://www.dandiarchive.org/handbook/

# This will use Material them
# Material theme
theme:
name: "material"
language: "en"
Expand All @@ -31,18 +31,25 @@ nav:
- Validation Levels for NWB Files: "135_validation.md"
- Publishing Dandisets: "14_publish.md"
- Debugging: "15_debugging.md"
- DANDI CLI and Python API: https://dandi.readthedocs.io
- Developer Guide:
- Project Structure: "20_project_structure.md"
- Notes: "40_development.md"
- REST API Swagger: https://api.dandiarchive.org/swagger
- REST API Redoc: https://api.dandiarchive.org/redoc
- Terms and Policies:
- Terms: "about/terms.md"
- Policies: "about/policies.md"
- About This Doc: "100_about_this_doc.md"

# list of extension
# List of extensions
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.critic
- toc:
permalink: True

# List of plugins
plugins:
- open-in-new-tab
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
mkdocs-material
pymdown-extensions
mkdocs-open-in-new-tab