-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #167 from kabilar/repo-url
Update links and text for repository rename from `handbook` to `dandi-docs`
- Loading branch information
Showing
5 changed files
with
14 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). | ||
|
@@ -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 [email protected]/<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 [email protected]/<username>/dandi-docs.git` , where `<username>` is your | ||
GitHub username. | ||
|
||
Once done, you need to run MkDocs. Simply type: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters