altf4arnold/datatracker
1
0
Fork 0
Code Issues Pull requests Actions 3 Packages Projects Releases Wiki Activity

docs: Suggest cloning a fork rather than ietf-tools repo (#3614)

Browse source
This commit is contained in:
Jim Fenton 2022-03-10 16:01:15 -08:00 committed by GitHub
parent c251b95e42
commit ccae60153c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -35,20 +35,25 @@ You can submit bug reports, enhancement and new feature requests in the [discuss
#### Git Cloning Tips
As outlined in the [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md) guide, you will first want to create a fork of the datatracker project in your personal GitHub account before cloning it.
Because of the extensive history of this project, cloning the datatracker project locally can take a long time / disk space. You can speed up the cloning process by limiting the history depth, for example:
- To fetch only up to the 10 latest commits:
```sh
git clone --depth=10 https://github.com/ietf-tools/datatracker.git
git clone --depth=10 https://github.com/jdoe/datatracker.git
```
- To fetch only up to a specific date:
```sh
git clone --shallow-since=DATE https://github.com/ietf-tools/datatracker.git
git clone --shallow-since=DATE https://github.com/jdoe/datatracker.git
```
But substitute your GitHub username in place of *jdoe*.
#### Overview of the datatracker models
A beginning of a [walkthrough of the datatracker models](https://notes.ietf.org/iab-aid-datatracker-database-overview) was prepared for the AIB AID workshop.
A beginning of a [walkthrough of the datatracker models](https://notes.ietf.org/iab-aid-datatracker-database-overview) was prepared for the IAB AID workshop.
#### Docker Dev Environment
In order to simplify and reduce the time required for setup, a preconfigured docker environment is available.