Skip to content

Commit d039db2

Browse files
committed
Fixing issues on the Git-DRS index page
1 parent ad474ef commit d039db2

1 file changed

Lines changed: 23 additions & 21 deletions

File tree

docs/tools/git-drs/docs/index.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,68 @@ title: Git-DRS
44

55
# Git-DRS
66

7-
Git-DRS is a Git extension for managing large files in a Gen3 Data Commons using the **Data Repository Service (DRS)** content-addressable storage model. It essentially serves as a Git-LFS (Large File Storage) replacement tailored for Gen3.
7+
Git-DRS is a Git extension for managing large files using the **Data Repository Service (DRS)** content-addressable storage model.
8+
It serves as a Git LFS (Large File Storage) replacement tailored for the GA4GH Data Repository Service specification.
89

910
It allows you to:
10-
- Track large files in your git repository without bloating it.
11+
12+
- Track large files in your Git repository without bloating it.
1113
- Store the actual file contents in a Gen3 data commons (indexed via DRS).
1214
- Seamlessly synchronize files between your local environment and the commons.
1315

1416
## Installation
1517

16-
Ensure `git-drs` is installed and in your PATH.
18+
Ensure `git-drs` is installed and available in your `PATH`.
1719

1820
## Initialization
1921

20-
Initialize a repository to use Git-DRS. This sets up the necessary hooks and configuration.
22+
Initialize a repository to use Git-DRS. This command sets up the necessary hooks and configuration.
2123

2224
```bash
23-
git-drs init
25+
git drs init
2426
```
2527

2628
## Basic Workflow
2729

2830
1. **Add a file**: Track a large file with Git-DRS.
2931
```bash
30-
git-drs add <filename>
32+
git drs add <filename>
3133
```
32-
This replaces the large file with a small pointer file in your working directory.
34+
This replaces the large file with a small pointer file in your working tree.
3335

34-
2. **Push**: Upload the tracked files to the Gen3 Commons.
36+
2. **Push**: Upload the tracked files to the DRS server.
3537
```bash
36-
git-drs push
38+
git drs push
3739
```
3840

39-
3. **Fetch**: Download file contents (resolving pointer files) from the Commons.
41+
3. **Fetch**: Download file contents (resolving pointer files) from the DRS server.
4042
```bash
41-
git-drs fetch
43+
git drs fetch
4244
```
4345

4446
## Command Reference
4547

4648
### `init`
47-
Initializes `git-drs` in the current git repository. Recommended to run at the root of the repo.
49+
Initialize `git-drs` in the current Git repository. Run this at the repository root.
4850

4951
### `add <file>`
50-
Tracks a file using Git-DRS. The file content is moved to a local cache, and replaced with a pointer file containing its hash and size.
52+
Track a file using Git-DRS. The file contents are moved to a local cache and replaced with a pointer file containing its hash and size.
5153

5254
### `push`
53-
Uploads the contents of tracked files to the configured Gen3 Commons. This usually happens automatically during `git push` if hooks are configured, but can be run manually.
55+
Upload tracked file contents to the configured DRS server. This usually happens automatically during `git push` if hooks are configured, but you can run it manually.
5456

5557
### `fetch`
56-
Downloads the contents of tracked files from the Gen3 Commons, replacing the local pointer files with the actual data.
58+
Download tracked file contents from the DRS server, replacing local pointer files with the actual data.
5759

5860
### `list`
59-
Lists the files currently tracked by Git-DRS in the project.
61+
List files currently tracked by Git-DRS in the project.
6062

6163
### `remote`
62-
Manage remote DRS server configurations.
64+
Manage remote DRS server configurations:
6365

6466
```bash
65-
git-drs remote add <name> <url>
66-
git-drs remote list
67-
git-drs remote set <name>
68-
git-drs remote remove <name>
67+
git drs remote add <name> <url>
68+
git drs remote list
69+
git drs remote set <name>
70+
git drs remote remove <name>
6971
```

0 commit comments

Comments
 (0)