Skip to content

Commit c36d18f

Browse files
authored
Update links for repository rename from handbook to dandi-docs
1 parent 033c139 commit c36d18f

5 files changed

+14
-14
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# DANDI Handbook
2-
Handbook for interacting with the DANDI Archive.
1+
# DANDI Docs
2+
Documentation for interacting with the DANDI Archive.
33

44
## DANDI Style Guidelines
55

6-
Follow the guidelines below when creating and revising text in the DANDI Handbook:
6+
Follow the guidelines below when creating and revising text in the DANDI Docs:
77

88
* **dandi-** repositories — hyphenate the names of DANDI GitHub repositories (e.g. **dandi-archive**); "Dandisets" is an exception because it is a
99
complete word
@@ -20,7 +20,7 @@ complete word
2020

2121
## HOWTO
2222

23-
This handbook uses [mkdocs](https://www.mkdocs.org/) to render the handbook written as a collection of markdown files into a website.
23+
The DANDI Docs uses [mkdocs](https://www.mkdocs.org/) to render the documentation written as a collection of markdown files into a website.
2424
If you would like to render it locally, you would need to create and configure a python environment according to configuration provided in [requirements.txt](./requirements.txt) file, e.g. via
2525

2626
python3 -m venv venv && source venv/bin/activate && python3 -m pip install -r requirements.txt

docs/100_contribute_docs.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to this Handbook
1+
# Contributing to this documentation
22

33
This documentation is a work in progress and we welcome all input: if something
44
is missing or unclear, let us know by [opening an issue on our helpdesk](https://github.com/dandi/helpdesk/issues/new/choose).
@@ -11,13 +11,13 @@ and extra plugins to generate the website.
1111
To test locally, you will need to install the Python dependencies. To do that, type the following commands:
1212

1313
```
14-
git clone https://github.com/dandi/handbook.git
15-
cd handbook
14+
git clone https://github.com/dandi/dandi-docs.git
15+
cd dandi-docs
1616
pip install -r requirements.txt
1717
```
1818

19-
If you are working on your *fork*, simply replace `https://github.com/dandi/handbook.git`
20-
with `git clone [email protected]/<username>/handbook.git` , where `<username>` is your
19+
If you are working on your *fork*, simply replace `https://github.com/dandi/dandi-docs.git`
20+
with `git clone [email protected]/<username>/dandi-docs.git` , where `<username>` is your
2121
GitHub username.
2222

2323
Once done, you need to run MkDocs. Simply type:

docs/20_project_structure.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ The DANDI project is organized around several **GitHub** repositories:
1616

1717
| Repository | Description |
1818
|----------|----------|
19-
| [DANDI archive](https://github.com/dandi/dandi-archive) | Contains the code for deploying the client-side Web application frontend based on the [Vue.js](https://vuejs.org/) framework as well as a Django-based backend to run the DANDI REST API.
19+
| [DANDI Archive](https://github.com/dandi/dandi-archive) | Contains the code for deploying the client-side Web application frontend based on the [Vue.js](https://vuejs.org/) framework as well as a Django-based backend to run the DANDI REST API.
2020
| [DANDI JupyterHub](https://github.com/dandi/dandi-hub) | Contains the code for deploying a JupyterHub instance to support interaction with the DANDI archive.
2121
| [DANDI Python client](https://github.com/dandi/dandi-cli) | Contains the code for the command line tool used to interact with the archive. It allows you to download data from the archive. It also allows you to locally organize and validate your data before uploading to the archive.
22-
| [handbook](https://github.com/dandi/handbook) | Provides the contents of this website.
22+
| [DANDI Docs](https://github.com/dandi/dandi-docs) | Provides the contents of this website.
2323
| [helpdesk](https://github.com/dandi/helpdesk) | Contains our community help platform where you can submit [issues](https://github.com/dandi/helpdesk/issues/new/choose).
2424
| [schema](https://github.com/dandi/schema) | Provides the details and some supporting code for the DANDI metadata schema.
2525
| [schema Python library](https://github.com/dandi/dandi-schema) | Provides a Python library for updating the schema and for creating and validating DANDI objects.

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ and use the tag [dandi](https://neurostars.org/tag/dandi).
3737
## Contributing and Feedback
3838

3939
We are looking for people to give us feedback on this documentation. If anything
40-
is unclear, [open an issue on our repository](https://github.com/dandi/handbook/issues). You can also get in touch on
40+
is unclear, [open an issue on our repository](https://github.com/dandi/dandi-docs/issues). You can also get in touch on
4141
our Slack channel, which is available to those who have
4242
registered an account on the archive.
4343

mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: DANDI Documentation
2-
repo_name: "dandi/handbook"
3-
repo_url: "https://github.com/dandi/handbook"
2+
repo_name: "dandi/dandi-docs"
3+
repo_url: "https://github.com/dandi/dandi-docs"
44
copyright: "CC-BY 4.0"
55
use_directory_urls: true
66
site_url: https://docs.dandiarchive.org

0 commit comments

Comments
 (0)