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

Add docs framework for how to clone a new DANDI instance #104

Open
wants to merge 79 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 78 commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
53ec1e3
Build out docs for Linc clone
Nov 20, 2023
ad50c71
progress
Nov 20, 2023
9e3af87
a bit more progress
Nov 20, 2023
0f0360d
progress x2
Nov 20, 2023
a4b12f5
more progress on docs
Nov 22, 2023
7747ac9
more progress
Nov 22, 2023
4c27961
bump docs again
Nov 22, 2023
52dc753
tf section
Nov 24, 2023
0c77256
build out netlifty section
Nov 28, 2023
7592ad6
Sentry included
Nov 28, 2023
026121b
include pypi docs
Nov 28, 2023
77d7599
Merge pull request #1 from lincbrain/ak-docs
aaronkanzer Nov 29, 2023
c648e1d
more bumps
Nov 29, 2023
eaa0495
Merge branch 'master' into ak-test
Nov 29, 2023
2e8931a
Merge pull request #2 from lincbrain/ak-test
aaronkanzer Nov 29, 2023
f0e5e80
include more specific token
Nov 29, 2023
7fb9a07
Merge pull request #3 from lincbrain/ak-token
aaronkanzer Nov 29, 2023
c5682f0
Attempt with personal token instead
Nov 29, 2023
c357ca2
bump value
Nov 29, 2023
aca1611
Trivial change for personal token
Nov 29, 2023
f07b04c
Merge pull request #4 from lincbrain/ak-personal-2
aaronkanzer Nov 29, 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
47ce471
Minor requirements bump to have mkdocs work
Jan 18, 2024
75fb959
more organization
Apr 8, 2024
1ecdafa
temp push
Apr 11, 2024
8d3ad40
merge main into ak-dandi-init
Apr 11, 2024
5af0e2e
Update docs/40_initialization.md
aaronkanzer Apr 11, 2024
a91bfd7
Update docs/40_initialization.md
aaronkanzer Apr 11, 2024
df3cc6c
Update docs/40_initialization.md
aaronkanzer Apr 11, 2024
b76d178
Update docs/40_initialization.md
aaronkanzer Apr 11, 2024
0f76cc7
Update docs/40_initialization.md
aaronkanzer Apr 11, 2024
d5dfac1
Update docs/40_initialization.md
aaronkanzer Apr 11, 2024
9361359
rename and reorganize files
Apr 11, 2024
1f2d7b8
More updates and outlines for future docs
Apr 11, 2024
bec7c29
Update outlines
Apr 11, 2024
f694167
minor update
Apr 11, 2024
bd96080
more seutp
Apr 11, 2024
4ec5d96
simplify
Apr 11, 2024
71c92b2
more progress on auth
Apr 18, 2024
9c2ec5c
more updates
Apr 18, 2024
67c4ad2
more progress on docs
Apr 18, 2024
3bc3fcc
more updates for superuser
Apr 18, 2024
a485fab
bump more progress
Apr 18, 2024
980d785
more archive updates
Apr 18, 2024
4c6876c
include allowed host section
Apr 18, 2024
c292b51
include approved users section
Apr 19, 2024
e0409db
minor cleanup
Apr 19, 2024
9d40f4f
Update docs/61_dandi_authentication.md
aaronkanzer Apr 19, 2024
9c24ec6
Update docs/61_dandi_authentication.md
aaronkanzer Apr 19, 2024
b07a695
Update docs/61_dandi_authentication.md
aaronkanzer Apr 19, 2024
71505db
Update docs/61_dandi_authentication.md
aaronkanzer Apr 19, 2024
754169a
Update docs/61_dandi_authentication.md
aaronkanzer Apr 19, 2024
52d48d5
Update docs/61_dandi_authentication.md
aaronkanzer Apr 19, 2024
61e4ad1
Update docs/61_dandi_authentication.md
aaronkanzer Apr 19, 2024
ebb7d33
Update mkdocs.yml
aaronkanzer Apr 19, 2024
dfb655c
bump docs
Apr 19, 2024
38cd078
more dandi infra org
Apr 22, 2024
2711cc5
continued progress on infra docs
Apr 23, 2024
ee02544
more progresS
Apr 23, 2024
8b5ed44
more infra docs
Apr 23, 2024
fb591c0
more infra docs
Apr 23, 2024
7f7951a
more progress
Apr 24, 2024
135cd36
more progress
Apr 24, 2024
ca76ae8
begin CLI docs
Apr 24, 2024
ddab9dd
temp bump on cli page
Apr 24, 2024
6bc3c70
resolve codespell
May 7, 2024
7dea59b
include section about dandi cache table
Oct 22, 2024
6c717d6
more progress on docs
Oct 25, 2024
f536a38
mini update
Oct 25, 2024
5ffc98e
merge upstream
Oct 25, 2024
32502ee
Remove neuroglancer docs for now for simplicity
Oct 25, 2024
d6a7c0c
include changes per some reviews
Oct 31, 2024
3ce4235
fix codespell
Oct 31, 2024
887bb46
Updates per review by Sandy Hider
Nov 6, 2024
fce80c7
Bump docs for CLI handling for clones
Nov 27, 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
2 changes: 1 addition & 1 deletion .github/workflows/publishdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ jobs:
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ node_modules
local_data

site/
venv/
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Handbook for interacting with the DANDI Archive.
Follow the guidelines below when creating and revising text in the DANDI Handbook:

* **dandi-** repositories — hyphenate the names of DANDI GitHub repositories (e.g. **dandi-archive**); "Dandisets" is an exception because it is a
complete word
complete word
* **Dandiset** — use single, unformatted, capitalized word (**not** dandiset or `Dandiset`)
* file names — use lower case (e.g. **development.md**)
* headings — use Title Capitalization (for 1st and 2nd levels) and follow with an intro sentence
Expand All @@ -28,6 +28,6 @@ If you would like to render it locally, you would need to create and configure a
And your current session would already be using that virtual Python environment, which you could deactivate by executing `deactivate` command.
If in the future you would need to activate it, just `source venv/bin/activate` again.

After that you can either
After that you can either
- do one time manual build using `mkdocs build` and find built website under `site/` folder.
- run `mkdocs serve` which would not only build website and start a local webserver for you to visit rendered version at e.g., http://0.0.0.0:8000/, but also it would automatically re-build if you change any source markdown or configuration file.
- run `mkdocs serve` which would not only build website and start a local webserver for you to visit rendered version at e.g., http://0.0.0.0:8000/, but also it would automatically re-build if you change any source markdown or configuration file.
4 changes: 4 additions & 0 deletions docs/59_getting_started_replicating_dandi.md
Original file line number Diff line number Diff line change
@@ -0,0 +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.
Loading
Loading