search

ACED-IDP / aced-idp.github.io

Documentation Site for the ACED Data Commons
https://aced-idp.github.io/
Apache License 2.0
1 stars 0 forks source link

quick use cases #19

Open jordan2lee opened 3 months ago

jordan2lee commented 3 months ago

reformat docs so there is one section for each use case that includes all commands to accomplish goal. with minimal text around it. links to other pages where more detailed explanation of commands are

jordan2lee commented 3 months ago

Add this as a new tab (at the same tier as "welcome to the aced-idp docmentation" "getting started" "requirements" "use cases and workflows" then this new section called "Quickstart Guide", "status monitor"

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

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 diff

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

2. Download Data

((The section that is on downloading data doesn't need to be changed and can be copied and pasted here. Specifically this page https://aced-idp.github.io/workflows/portal-download/))

matthewpeterkort commented 3 months ago

see https://github.com/ACED-IDP/aced-idp.github.io/pull/21