Skip to content

Commit

Permalink
Adds quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewpeterkort authored and lbeckman314 committed May 22, 2024
1 parent 347d703 commit cc6f044
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
52 changes: 52 additions & 0 deletions docs/workflows/quick-start-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@

# Quickstart Guide

## 1. Upload Data (To an Existing Project on ACED IDP)
This section outlines how to add data to ACED IDP. Many `g3t` commands behave similarily to `git` commands

Initialize a new project
```
g3t init aced-demo
```

Clone an existing project
```
g3t clone aced-demo
```

Add file(s)
```
g3t add folder/file.tsv
g3t add folder/file2.tsv
```

Create meta data for your files. This `g3t` command will take care of creating this for you
```
g3t utilities meta create
```

Check that the expected files are queued for upload
```
g3t status
```

Commit files
```
g3t commit -m "Adding files"
```

Push to ACED IDP
```
g3t push
```

View the upload status (pending or complete)
```
g3t status
```

Check that your data was uploaded successfully by viewing on the Exploration tab on [aced-idp.org](https://aced-idp.org)

## 2. Download Data

Refer to the downloads [page](https://aced-idp.github.io/workflows/portal-download/)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ site_name: ACED-IDP Documentation
nav:
- index.md
- getting-started.md
- workflows/quick-start-guide.md
- Requirements:
- requirements/gen3-client.md
- requirements/gen3-tracker.md
Expand Down

0 comments on commit cc6f044

Please sign in to comment.