Skip to content

Commit e29637b

Browse files
authored
docs: update README
1 parent dc7e3b9 commit e29637b

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@
1919
- [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md)
2020
- [Getting Started](#getting-started)
2121
- [Prerequisites](#prerequisites)
22+
- [Git Cloning Tips](#git-cloning-tips)
2223
- [Code Tree Overview](#code-tree-overview)
2324
- [Adding a New Web Page](#adding-a-new-web-page)
2425
- [Testing your work](#testing-your-work)
25-
- [Docker Dev Environment](#docker-dev-environment)
26+
- [Docker Dev Environment](docker/README.md)
2627
- [Continuous Integration](#continuous-integration)
2728
- [Database & Assets](#database--assets)
2829

@@ -43,19 +44,19 @@ You can submit bug reports, enhancement and new feature requests in the [discuss
4344
- Node.js 16.x
4445
- MariaDB 10
4546

46-
> See the [Docker Dev Environment](#docker-dev-environment) section below for a preconfigured docker environment.
47+
> See the [Docker Dev Environment](docker/README.md) section for a preconfigured docker environment.
4748
4849
#### Git Cloning Tips
4950

50-
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:
51+
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:
5152

5253
- To fetch only up to the 10 latest commits:
5354
```sh
54-
git clone --depth=10
55+
git clone --depth=10 https://github.com/ietf-tools/datatracker.git
5556
```
5657
- To fetch only up to a specific date:
5758
```sh
58-
git clone --shallow-since=DATE
59+
git clone --shallow-since=DATE https://github.com/ietf-tools/datatracker.git
5960
```
6061

6162
#### Code Tree Overview

0 commit comments

Comments
 (0)