Skip to content

Commit

Permalink
Merge pull request #167 from kabilar/repo-url
Browse files Browse the repository at this point in the history
Update links and text for repository rename from `handbook` to `dandi-docs`
  • Loading branch information
bendichter authored Jan 13, 2025
2 parents 033c139 + c36d18f commit a3833ac
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# DANDI Handbook
Handbook for interacting with the DANDI Archive.
# DANDI Docs
Documentation for interacting with the DANDI Archive.

## DANDI Style Guidelines

Follow the guidelines below when creating and revising text in the DANDI Handbook:
Follow the guidelines below when creating and revising text in the DANDI Docs:

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

## HOWTO

This handbook uses [mkdocs](https://www.mkdocs.org/) to render the handbook written as a collection of markdown files into a website.
The DANDI Docs uses [mkdocs](https://www.mkdocs.org/) to render the documentation written as a collection of markdown files into a website.
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

python3 -m venv venv && source venv/bin/activate && python3 -m pip install -r requirements.txt
Expand Down
10 changes: 5 additions & 5 deletions docs/100_contribute_docs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to this Handbook
# Contributing to this documentation

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

```
git clone https://github.com/dandi/handbook.git
cd handbook
git clone https://github.com/dandi/dandi-docs.git
cd dandi-docs
pip install -r requirements.txt
```

If you are working on your *fork*, simply replace `https://github.com/dandi/handbook.git`
with `git clone git@github.com/<username>/handbook.git` , where `<username>` is your
If you are working on your *fork*, simply replace `https://github.com/dandi/dandi-docs.git`
with `git clone git@github.com/<username>/dandi-docs.git` , where `<username>` is your
GitHub username.

Once done, you need to run MkDocs. Simply type:
Expand Down
4 changes: 2 additions & 2 deletions docs/20_project_structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ The DANDI project is organized around several **GitHub** repositories:

| Repository | Description |
|----------|----------|
| [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.
| [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.
| [DANDI JupyterHub](https://github.com/dandi/dandi-hub) | Contains the code for deploying a JupyterHub instance to support interaction with the DANDI archive.
| [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.
| [handbook](https://github.com/dandi/handbook) | Provides the contents of this website.
| [DANDI Docs](https://github.com/dandi/dandi-docs) | Provides the contents of this website.
| [helpdesk](https://github.com/dandi/helpdesk) | Contains our community help platform where you can submit [issues](https://github.com/dandi/helpdesk/issues/new/choose).
| [schema](https://github.com/dandi/schema) | Provides the details and some supporting code for the DANDI metadata schema.
| [schema Python library](https://github.com/dandi/dandi-schema) | Provides a Python library for updating the schema and for creating and validating DANDI objects.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ and use the tag [dandi](https://neurostars.org/tag/dandi).
## Contributing and Feedback

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

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: DANDI Documentation
repo_name: "dandi/handbook"
repo_url: "https://github.com/dandi/handbook"
repo_name: "dandi/dandi-docs"
repo_url: "https://github.com/dandi/dandi-docs"
copyright: "CC-BY 4.0"
use_directory_urls: true
site_url: https://docs.dandiarchive.org
Expand Down

0 comments on commit a3833ac

Please sign in to comment.