Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Encyclopedia from Develop #268

Open
wants to merge 311 commits into
base: encyclopedia
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
311 commits
Select commit Hold shift + click to select a range
0869503
Update fox release
purplepeopleeater Feb 7, 2018
0b5769c
Fox release update
purplepeopleeater Feb 7, 2018
cc71d74
Survival Analysis Import
Feb 7, 2018
82a2a25
Fox release update
purplepeopleeater Feb 7, 2018
3f36f25
Fox image update
purplepeopleeater Feb 7, 2018
82957ae
Fox updates
purplepeopleeater Feb 7, 2018
39bd488
Image update fox release
purplepeopleeater Feb 7, 2018
88d8024
Fox release updates
purplepeopleeater Feb 7, 2018
6cb7856
Update Data_Portal_Release_Notes.md
phuongmy Feb 8, 2018
a02bf6b
Fox release updates
purplepeopleeater Feb 7, 2018
f5a8ccc
Fox release update
purplepeopleeater Feb 7, 2018
a35f32d
Added Data version 10.1 update
msfitzsimons Feb 6, 2018
7682211
Fox release updates
purplepeopleeater Feb 8, 2018
eae5928
Doc update for fox release
purplepeopleeater Feb 8, 2018
f9be2f1
Updates for fox release
purplepeopleeater Feb 8, 2018
19570f2
Fox release update
purplepeopleeater Feb 8, 2018
6acd88c
Update fox release
purplepeopleeater Feb 8, 2018
f71e7cf
Rename image
purplepeopleeater Feb 8, 2018
14d17f1
Fox updates add back in summary page
purplepeopleeater Feb 8, 2018
15b868d
small typo in UG
msfitzsimons Feb 8, 2018
13264c9
Merge pull request #246 from NCIP/Fox_release
msfitzsimons Feb 8, 2018
b6848f2
Updating nodes docs
Feb 9, 2018
b197153
Updated images for fox release
purplepeopleeater Feb 9, 2018
8523629
Changed Release Notes Dates
Feb 15, 2018
06311a5
Minor update to release notes
msfitzsimons Feb 16, 2018
9a13a82
Updated Tables
cpreid2 Mar 6, 2018
d5f97c7
Fixed Release Notes Pages
cpreid2 Mar 6, 2018
5ee18e7
SV-1017 broken links updates
msfitzsimons Mar 22, 2018
582b2b5
Update Data_Portal_Release_Notes.md
phuongmy Mar 26, 2018
469a8f7
Update Data_Submission_Portal_Release_Notes.md
phuongmy Mar 26, 2018
2ecea2a
Update Data_Portal_Release_Notes.md
phuongmy Mar 26, 2018
1f223ec
target capture kit q and a
msfitzsimons Mar 26, 2018
c178e58
Release Notes
cpreid2 Mar 26, 2018
b1fe260
data release notes update
msfitzsimons Mar 26, 2018
1079128
API release notes
msfitzsimons Mar 26, 2018
d86c2f5
Add files via upload
phuongmy Mar 26, 2018
aaa449e
Add files via upload
phuongmy Mar 26, 2018
2cb8635
Update Data_Portal_UG.yml
Fgerthoffert Mar 26, 2018
8a27d33
Added GDCMVS app to gdc-docs
fmanuelos Mar 26, 2018
782894a
Update Getting_Started.md
phuongmy Mar 29, 2018
3bd393c
Update Image_viewer.md
phuongmy Mar 29, 2018
7fe38cf
Add files via upload
phuongmy Mar 29, 2018
43321d6
Update Data_Submission_Portal_Release_Notes.md
phuongmy Apr 4, 2018
031f30e
Merge pull request #249 from NCIP/develop
msfitzsimons Apr 5, 2018
95103da
DTT UI release notes update
msfitzsimons Apr 5, 2018
49d21e4
DTT UI Release notes update
msfitzsimons Apr 5, 2018
45e6282
Release Notes
cpreid2 Apr 6, 2018
a56026e
Add files via upload
phuongmy Apr 10, 2018
b16825c
:sparkles: DOC-76 hide deprecated enums and properties
cy Apr 10, 2018
75b4080
:sparkles: DOC-75 display list of true, false for boolean
cy Apr 10, 2018
ccac310
Updates to release notes
cpreid2 Apr 11, 2018
61630b7
Merge pull request #253 from NCIP/Horton
msfitzsimons Apr 11, 2018
3382dbc
DOC-96 hide batch_id
cy Apr 10, 2018
abc5e5a
Release notes update for Horton Release
msfitzsimons Apr 13, 2018
ba256ae
Added localStorage to GDCMVS app
fmanuelos Apr 18, 2018
8ad8560
Changed modified to added for molecular_test node
Apr 18, 2018
0b129d8
Data release notes update
msfitzsimons Apr 20, 2018
470a323
Modified data model images in submission docs to match new dictionary
Apr 20, 2018
4788d10
Merge branch 'develop' of https://github.com/NCIP/gdc-docs into develop
Apr 20, 2018
6249fc8
Merge branch 'develop' into Gack
msfitzsimons Apr 23, 2018
09e66b6
remove GDC cBioPortal from Encyclopedia
msfitzsimons Apr 24, 2018
72c355b
Encyclopedia updates
msfitzsimons Apr 26, 2018
2ee7a46
Fixing Horton to Gack merge issues
msfitzsimons Apr 26, 2018
d910e72
TARGET NBL bug added to release notes
msfitzsimons May 4, 2018
e2e0848
Add slides to case tab description
rosibaj May 4, 2018
678099c
Add files via upload
rosibaj May 4, 2018
8cf8383
Add files via upload
rosibaj May 4, 2018
675da8f
case-table update
rosibaj May 4, 2018
58a9bea
update file navigation image
rosibaj May 4, 2018
f4ea7c9
update input set image
rosibaj May 4, 2018
83ec53b
Update images/text for Exploration page docs
rosibaj May 4, 2018
d032b19
Merge pull request #256 from rosibaj/patch-1
rosibaj May 4, 2018
44fcd14
TARGET NBL release notes update
msfitzsimons May 4, 2018
d4dd74b
Add files via upload
rosibaj May 4, 2018
1787135
update project page screenshot
rosibaj May 4, 2018
5d0b8cd
Change position for preventDefault function
fmanuelos May 8, 2018
68c5218
TCGA Barcode Page
msfitzsimons May 10, 2018
b9e7a41
Back Release Notes Updates
msfitzsimons May 10, 2018
a1fff90
Merge branch 'develop' into Gack
msfitzsimons May 10, 2018
3befb79
Gack release notes update
msfitzsimons May 10, 2018
ad050b2
Gack updates
msfitzsimons May 10, 2018
69d38c2
TCGA Barcode page
msfitzsimons May 10, 2018
f696d63
Update to Submission Workflow diagrams
msfitzsimons May 11, 2018
36b0ce0
Add files via upload
rosibaj May 14, 2018
864b9e6
Add files via upload
rosibaj May 14, 2018
cc6199b
Add files via upload
rosibaj May 14, 2018
9d676cf
Update Browse_Data.md
rosibaj May 14, 2018
5d64fe9
Merge pull request #258 from NCIP/Gack
msfitzsimons May 14, 2018
78f2f7c
back minor update
msfitzsimons May 14, 2018
6207c44
Minor Gack updates
msfitzsimons May 14, 2018
ef8153c
Minor Gack update
msfitzsimons May 14, 2018
32315b9
Minor Gack updates for DTT UI release notes
msfitzsimons May 14, 2018
852b0c4
Back Release Notes updates
msfitzsimons May 15, 2018
48d379e
Dates and manifest/swaps files for Gack release
msfitzsimons May 21, 2018
82be802
Gack swap and manifest files
msfitzsimons May 21, 2018
8dbedb9
rollback of submission workflow changes
msfitzsimons May 21, 2018
1741ac5
submission portal version update
msfitzsimons May 21, 2018
09b5b18
Data portal release notes update
msfitzsimons May 21, 2018
0bd55db
Merge pull request #252 from NCIP/gdcmvs
Fgerthoffert May 29, 2018
13bb829
Ish Release Notes and footer link update
msfitzsimons May 30, 2018
3954f34
Corrected two typos
May 31, 2018
0f9015c
Ish Release Notes
msfitzsimons Jun 4, 2018
95d4915
Revert "Added GDCMVS app to gdc-docs"
msfitzsimons Jun 5, 2018
f94b010
Merge pull request #262 from NCIP/revert-252-gdcmvs
msfitzsimons Jun 5, 2018
495c5fa
Revert "Merge pull request #252 from NCIP/gdcmvs"
msfitzsimons Jun 5, 2018
f4fd9f6
data release notes for Ish
msfitzsimons Jun 5, 2018
4f64af2
Ish release notes update
msfitzsimons Jun 5, 2018
c709dae
Updated data portal release notes for 1.14
rosibaj Jun 6, 2018
7ebee37
Ish Release Notes Date updates
msfitzsimons Jun 11, 2018
9d65324
Added release notes from ORR
Jun 11, 2018
18553e0
Added SNP6 probeset information
Jun 11, 2018
2141bfe
Submission doc update
purplepeopleeater Jun 12, 2018
74a7c5b
Merge pull request #264 from NCIP/Ish
msfitzsimons Jun 12, 2018
3ff0828
manifest and swap files for Ish
msfitzsimons Jun 12, 2018
a0571b2
date updates
msfitzsimons Jun 13, 2018
4dfaf55
changed file names
msfitzsimons Jun 13, 2018
9712e4c
minor release notes update
msfitzsimons Jun 14, 2018
eb2cc0b
AWG Docs
msfitzsimons Jun 18, 2018
4a13a45
AWG docs updates
msfitzsimons Jun 18, 2018
6408223
Remove general portal features from the Pre-release portal user guide
msfitzsimons Jun 19, 2018
f2b52db
AWG UG updates
msfitzsimons Jun 19, 2018
1bcd688
API URL name updated
msfitzsimons Jun 19, 2018
30f3f08
Added DTT Flag
msfitzsimons Jun 20, 2018
6c4dcd4
Removing general GDC Data Portal content from AWG UG
msfitzsimons Jun 24, 2018
2ed0309
Added pre-release data portal release notes
msfitzsimons Jun 27, 2018
4cf8733
Release Notes Updates after ORR
msfitzsimons Jun 29, 2018
6360fa4
Merge pull request #267 from NCIP/Kay
msfitzsimons Jul 2, 2018
85ee00d
AWG Release Notes updates
msfitzsimons Jul 12, 2018
8da946a
Changed Release Date
Jul 12, 2018
3f9cc6f
Merge branch 'develop' into Ichabod
msfitzsimons Jul 20, 2018
33f953b
Early draft of UG for versioning
msfitzsimons Jul 24, 2018
8a3b106
Additional updates for versioning release
msfitzsimons Jul 24, 2018
7053470
More updates to versioning docs
msfitzsimons Jul 27, 2018
3056ec7
Add release 15 portal notes
rosibaj Jul 30, 2018
11aa294
Ichabod File Versioning Updates
rosibaj Jul 30, 2018
cc1dc3a
Update for ichabod versioning changes
rosibaj Jul 30, 2018
d62009d
remove link to change log
rosibaj Jul 30, 2018
194b9b0
remove link to change log
rosibaj Jul 30, 2018
e7c5a64
More updates for versioning
msfitzsimons Jul 30, 2018
7393c69
small updates to UG for versioning
msfitzsimons Jul 31, 2018
150e08c
Update Data_Portal_Release_Notes.md
rosibaj Jul 31, 2018
11b068d
Add files via upload
rosibaj Jul 31, 2018
a4f8919
file repo screenshot update
rosibaj Jul 31, 2018
d6bbbb1
Add files via upload
rosibaj Jul 31, 2018
56ba9d2
Add files via upload
rosibaj Jul 31, 2018
0467667
update set screenshot
rosibaj Jul 31, 2018
aef5d15
Update Custom_Set_Analysis.md
rosibaj Jul 31, 2018
93ec373
updated exploration screenshots
rosibaj Jul 31, 2018
984c1f8
Add files via upload
rosibaj Jul 31, 2018
22e9da3
Add files via upload
rosibaj Jul 31, 2018
63e0f73
updated screenshots for ichabod
rosibaj Jul 31, 2018
59f3297
Add files via upload
rosibaj Jul 31, 2018
1df6a71
Add files via upload
rosibaj Jul 31, 2018
41ae62b
Add files via upload
rosibaj Jul 31, 2018
712ea8f
Add files via upload
rosibaj Jul 31, 2018
f765231
Delete GDC_SUBMIT_TO_GDC_v2.png .png
rosibaj Jul 31, 2018
8661310
update screenshots to request submission
rosibaj Jul 31, 2018
b49b7d7
More Ichabod UG updates
msfitzsimons Aug 3, 2018
7f1f525
Add files via upload
rosibaj Aug 7, 2018
79ffe42
Update Submit_Data.md
rosibaj Aug 7, 2018
f9e4f27
Update Release_Data.md
rosibaj Aug 7, 2018
37f8005
Update Getting_Started.md
rosibaj Aug 7, 2018
f0a78b3
Add files via upload
rosibaj Aug 7, 2018
8363a76
Add files via upload
rosibaj Aug 7, 2018
e7f1040
Update Release_Data.md
rosibaj Aug 7, 2018
860bc6d
homepage image update
rosibaj Aug 7, 2018
c8ac0f7
update with released/requested release status
rosibaj Aug 7, 2018
eebe1ac
More updates for Ichabod
msfitzsimons Aug 8, 2018
78d060f
Updates for Ichabod
msfitzsimons Aug 8, 2018
ecf961f
Updates for Ichabod
msfitzsimons Aug 9, 2018
aa777df
More Ichabod updates
msfitzsimons Aug 10, 2018
ae47533
Versioning UG updates
msfitzsimons Aug 17, 2018
f88095b
Merge pull request #270 from NCIP/Ichabod
msfitzsimons Aug 20, 2018
fe933e6
Revert "Merge pull request #270 from NCIP/Ichabod"
msfitzsimons Aug 20, 2018
cd237df
Revert "Revert "Merge pull request #270 from NCIP/Ichabod""
msfitzsimons Aug 20, 2018
a460e7a
Updated GraphiQL link
Aug 21, 2018
42dfcb1
Ichabod updates
msfitzsimons Aug 21, 2018
45d4fb7
Added release dates
msfitzsimons Aug 23, 2018
2df371d
🐛 Make deprecated fields case-sensitive
anncatton Aug 24, 2018
9e28a7e
updated
purplepeopleeater Aug 24, 2018
dc64c20
update
purplepeopleeater Aug 24, 2018
038dd0f
updates
purplepeopleeater Aug 24, 2018
1ea09e3
update
purplepeopleeater Aug 24, 2018
5b2c182
link update
purplepeopleeater Aug 24, 2018
d36a53c
update to listing of files
purplepeopleeater Aug 24, 2018
161043e
update links
purplepeopleeater Aug 24, 2018
5709f1b
update image and table
purplepeopleeater Aug 27, 2018
7bf19a8
update formating
purplepeopleeater Aug 28, 2018
723d08e
update formating
purplepeopleeater Aug 28, 2018
4478588
update
purplepeopleeater Aug 28, 2018
3b7d9cf
formating updates
purplepeopleeater Aug 28, 2018
0bb6fb8
Removing legacy/data endpoint references
msfitzsimons Aug 30, 2018
e0e12bb
update formating
purplepeopleeater Aug 30, 2018
735e977
New Data Submission Documentation: Checklist.md
svburke Aug 31, 2018
46b5069
Revert "New Data Submission Documentation: Checklist.md"
msfitzsimons Aug 31, 2018
9ca222f
update formating
purplepeopleeater Aug 31, 2018
609c3dd
Jibboo release notes
msfitzsimons Sep 4, 2018
336484d
update to format.
purplepeopleeater Sep 4, 2018
6b61f53
Merge branch 'Jibboo' of https://github.com/NCIP/gdc-docs into Jibboo
purplepeopleeater Sep 4, 2018
c6d519a
format updates
purplepeopleeater Sep 5, 2018
7a16de7
formating update
purplepeopleeater Sep 5, 2018
c3524cc
format update
purplepeopleeater Sep 6, 2018
9f09ef2
formating update
purplepeopleeater Sep 6, 2018
8ceebc3
formating update
purplepeopleeater Sep 6, 2018
f01f690
format updates
purplepeopleeater Sep 10, 2018
888ae48
Merge pull request #272 from NCIP/PRTL-2180-case-sensitive-deprecated…
anncatton Sep 10, 2018
1ed9149
format updates
purplepeopleeater Sep 10, 2018
0b62228
format update
purplepeopleeater Sep 11, 2018
0accac8
Revert "🐛 Make deprecated fields case-sensitive"
anncatton Sep 11, 2018
45f1df2
Merge pull request #274 from NCIP/revert-272-PRTL-2180-case-sensitive…
anncatton Sep 11, 2018
03cdd30
format update
purplepeopleeater Sep 11, 2018
ce9d318
reverts changes from incorrect merge PR-272
anncatton Sep 12, 2018
88265db
🐛 make deprecated fields case sensitive
anncatton Sep 12, 2018
5b6415c
Merge pull request #276 from NCIP/revert-case-sensitive-pr
anncatton Sep 12, 2018
0fa557a
Merge pull request #277 from NCIP/fix/PRTL-2180-case-sensitive-deprec…
anncatton Sep 12, 2018
98d3e89
update annoatations
purplepeopleeater Sep 12, 2018
9b19d2c
link update
purplepeopleeater Sep 12, 2018
b2b9a24
Dictionary Release Notes
cpreid2 Sep 13, 2018
e613d05
Last Fix
cpreid2 Sep 13, 2018
2d62ea8
CGI bam annotation
msfitzsimons Sep 13, 2018
41c456b
format and removal of login intro to Annotations Manager application
purplepeopleeater Sep 19, 2018
6f66fa6
update format
purplepeopleeater Sep 19, 2018
645ff2b
Release Notes Updates
msfitzsimons Sep 19, 2018
34c8f7a
Merge pull request #278 from NCIP/Jibboo
msfitzsimons Sep 19, 2018
8c42dab
Updates to Release Notes
msfitzsimons Sep 20, 2018
3399d6a
User Guide Updates
msfitzsimons Sep 20, 2018
c4b9c3e
fixing format errors in user guides
msfitzsimons Sep 20, 2018
98c4933
fixing format errors
msfitzsimons Sep 20, 2018
ef99678
format error fixes
msfitzsimons Sep 20, 2018
23b3764
more error fixes
msfitzsimons Sep 20, 2018
052d2c1
more error fixes
msfitzsimons Sep 20, 2018
56bf196
more error fixes
msfitzsimons Sep 20, 2018
acde8a8
more error fixes
msfitzsimons Sep 20, 2018
6ec8d40
more formatting errors
msfitzsimons Sep 20, 2018
0ae29c9
other format fixes
msfitzsimons Sep 20, 2018
d8072ab
more format fixes
msfitzsimons Sep 20, 2018
6d6adec
more formatting issues
msfitzsimons Sep 20, 2018
7f60a04
more format errors
msfitzsimons Sep 20, 2018
58d6d32
remove TCGA MAF format from encyclopedia
msfitzsimons Sep 20, 2018
3343417
remove TCGA MAF format pages
msfitzsimons Sep 20, 2018
9044c6e
remove TCGA VCF page
msfitzsimons Sep 20, 2018
cc45c89
fix formatting error
msfitzsimons Sep 20, 2018
9ecc039
fixing format issues
msfitzsimons Sep 20, 2018
302727f
Release Notes Updates
msfitzsimons Sep 27, 2018
94e0903
Minor fixes to release notes
msfitzsimons Sep 28, 2018
0cf7254
Added known bugs that were discovered today - SNP6/SlideImages
Oct 3, 2018
2cd2246
Small typos
Oct 3, 2018
c7dea7c
Added manifest for 542 files from DR13
Oct 3, 2018
dd6f888
Uploaded actual manifest file
Oct 3, 2018
aa9e6a9
Update README.md
msfitzsimons Oct 30, 2018
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
site/
.DS_Store
.DS_Store
venv/
1 change: 1 addition & 0 deletions Data_Portal_UG.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ pages:
- Advanced Search: 'Data_Portal/Users_Guide/Advanced_Search.md'
- Authentication: 'Data_Portal/Users_Guide/Authentication.md'
- File Cart: 'Data_Portal/Users_Guide/Cart.md'
- Image Viewer: 'Data_Portal/Users_Guide/Image_viewer.md'
- Legacy Archive: 'Data_Portal/Users_Guide/Legacy_Archive.md'
- Release Notes: 'Data_Portal/Release_Notes/Data_Portal_Release_Notes.md'
extra:
Expand Down
1 change: 1 addition & 0 deletions Data_Submission_Portal_UG.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ pages:
- Release Data: 'Data_Submission_Portal/Users_Guide/Release_Data.md'
- Transactions: 'Data_Submission_Portal/Users_Guide/Transactions.md'
- Browse Data: 'Data_Submission_Portal/Users_Guide/Browse_Data.md'
- Pre-Release Data Review: 'Data_Submission_Portal/Users_Guide/Pre_Release_QC.md'
- Best Practices: 'Data_Submission_Portal/Users_Guide/Best_Practices.md'
- Release Notes: 'Data_Submission_Portal/Release_Notes/Data_Submission_Portal_Release_Notes.md'
extra:
Expand Down
84 changes: 2 additions & 82 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,87 +1,7 @@
![](https://gdc.cancer.gov/sites/all/themes/gdc_bootstrap/logo.png)

# GDC Open Source code
# THIS PROJECT HAS MOVED

GDC is Open Source, Github Repositories containing source code of GDC Applications can be found on [GDC GitHub Organization page](https://github.com/NCI-GDC/).

- GDC Data Portal: https://github.com/NCI-GDC/portal-ui
- GDC Legacy Archive: https://github.com/NCI-GDC/portal-ui-legacy
- GDC Data Transfer Tool: https://github.com/NCI-GDC/gdc-client
- GDC Data Dictionary: https://github.com/NCI-GDC/gdcdictionary
- GDC Data Model: https://github.com/NCI-GDC/gdcdatamodel
- GDC Psqlgraph: https://github.com/NCI-GDC/psqlgraph

# Support

Please direct technical questions to [GDC Support](https://gdc.cancer.gov/support).

# GDC Documentation Site

### Technology

- Python 2.6, 2.7, 3.3, 3.4 and 3.5.
- [mkdocs](http://www.mkdocs.org/)
- [BSCodeTabs for mkdocs](https://github.com/mikecules/MarkdownBSCodeTabs#for-use-in-mkdocs)

### Install & Run

- `pip install -r requirements`
- `mkdocs serve` (optionally set port `--dev-addr=0.0.0.0:<PORT>`)

### Build

- `mkdocs build --clean`

### Repository Conventions

- All Shared content in the "Commons" directory
- One Directory per GDC product (API, Data_Portal, Data_Submission_Portal, Data_Transfer_Tool)
- Each GDC product have a Users_Guide and Release_Notes directory

### Linking

To another documentation page
```
[Authentication and Authorization](../../Commons/Authentication.md)
```

Inside another documentation page

```
[Authentication and Authorization](../../Commons/Authentication.md#internal-section)
```

### Adding icons and PDFs
The convention for this, when updating mkdocs.yml is the following:
- <font-awesome-icon> <content> <url ending in .pdf>: 'index.md'
example:
- fa-file-pdf-o Download PDF /API/PDF/API_UG.pdf: 'index.md'

### Documentation Conventions

A detailed list of all conventions is available on [GDC Website](https://gdc.cancer.gov/conventions-page)


### Build PDF

Install mkdocs2pandoc, following instructions available here:
```
https://github.com/jgrassler/mkdocs-pandoc
```

Prepare a yml file dedicated to your Userguide, using Data_Portal_UG.yml as an example.

Run the following commands to:
* Convert the User Guide to Pandoc:
* Tweak the pandoc file
* Build a PDF

```
mkdocs2pandoc -f Data_Portal_UG.yml -o docs/Data_Portal/PDF/Data_portal_UG.pd
sed -i -e 's/# / /g' docs/Data_Portal/PDF/Data_portal_UG.pd
sed -i -e 's/### /## /g' docs/Data_Portal/PDF/Data_portal_UG.pd
sed -i -e 's/\/site\//\/docs\//g' docs/Data_Portal/PDF/Data_portal_UG.pd
pandoc --toc -V documentclass=report -V geometry:"top=2cm, bottom=1.5cm, left=1cm, right=1cm" -f markdown+grid_tables+table_captions -o docs/Data_Portal/PDF/Data_portal_UG.pdf docs/Data_Portal/PDF/Data_portal_UG.pd
```
Please join us at https://github.com/NCI-GDC/gdc-docs


127 changes: 126 additions & 1 deletion docs/API/Release_Notes/API_Release_Notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,131 @@
# API Release Notes


| Version | Date |
|---|---|
| [v1.16.0](API_Release_Notes.md#v1160) | September 27, 2018 |
| [v1.15.0](API_Release_Notes.md#v1150) | August 23, 2018 |
| [v1.14.1](API_Release_Notes.md#v1141) | May 21, 2018 |
| [v1.14.0](API_Release_Notes.md#v1140) | April 23, 2018 |
| [v1.13.0](API_Release_Notes.md#v1130) | February 15, 2018 |
| [v1.12.0](API_Release_Notes.md#v1120) | December 21, 2017 |
| [v1.11.0](API_Release_Notes.md#v1110) | November 16, 2017 |
| [v1.10.0](API_Release_Notes.md#v1100) | August 22, 2017 |
| [v1.9.0](API_Release_Notes.md#v190) | June 29, 2017 |
| [v1.8.0](API_Release_Notes.md#v180) | May 9, 2017 |
| [v1.7.1](API_Release_Notes.md#v171) | March 16, 2017 |
| [v1.5.0](API_Release_Notes.md#v150) | October 31, 2016 |
| [v1.4.0](API_Release_Notes.md#v140) | September 23, 2016 |
| [v1.3.1](API_Release_Notes.md#v131) | September 7, 2016 |
| [v1.2.0](API_Release_Notes.md#v120) | August 9, 2016 |
| [v1.1.0](API_Release_Notes.md#v110) | May 25, 2016 |
| [v1.0.1](API_Release_Notes.md#v101) | May 16, 2016 |

## v1.16.0

* __GDC Product__: Application Programming Interface (API)
* __Release Date__: September 27, 2018

### New Features and Changes

* Tissue_type is now parsed from the BCR Biospecimen submission <!--TT-753-->


### Bugs Fixed Since Last Release

* Re-attach the /files path to the legacy blueprints in gdcapi <!--SV-1195-->
* Fix Internal Server Error when exporting JSON in Data Portal <!--SV-1209-->

### Known Issues and Workarounds

* Fields are not counted as missing if parent field is also missing. This may occur with queries of nested fields in the Data Portal Advanced Search or an API query using a filter. This behavior could impact results reported using search parameters of "IS MISSING" or "NOT MISSING". <!-- PGDC-2530 // https://github.com/NCI-GDC/gdcapi/pull/524 -->
* Certain very large API requests will time out. It is recommended to break up very large requests into a series of smaller requests. <!-- PGDC-2411 -->




## v1.15.0

* __GDC Product__: Application Programming Interface (API)
* __Release Date__: August 23, 2018

### New Features and Changes

* Added support for file versioning <!--TT-482-->
* Added new API endpoints in support of versioning: history, files/versions, and files/versions/manifest <!--PRTL-2015-->
* Updated the submit and release process <!--TT-249-->
* Created admin endpoint to allow for modifying file and project flags and states <!--API-368-->
* Populate version and release information for all existing files <!--TT-154-->

### Bugs Fixed Since Last Release

* None

### Known Issues and Workarounds

* Fields are not counted as missing if parent field is also missing. This may occur with queries of nested fields in the Data Portal Advanced Search or an API query using a filter. This behavior could impact results reported using search parameters of "IS MISSING" or "NOT MISSING". <!-- PGDC-2530 // https://github.com/NCI-GDC/gdcapi/pull/524 -->
* Certain very large API requests will time out. It is recommended to break up very large requests into a series of smaller requests. <!-- PGDC-2411 -->


## v1.14.1

* __GDC Product__: Application Programming Interface (API)
* __Release Date__: May 21, 2018

### New Features and Changes

* None

### Bugs Fixed Since Last Release

* Update to XML submission to correctly import biospecimen relationnships <!--TT-578-->
* GraphQL submission queries return incorrect information <!--SV-1086-->

### Known Issues and Workarounds

* The error message for not including a token is incorrect for controlled access API requests (e.g. bam slicing). It states that your token is invalid, but it should request that a token be supplied. <!--API-495-->
* Fields are not counted as missing if parent field is also missing. This may occur with queries of nested fields in the Data Portal Advanced Search or an API query using a filter. This behavior could impact results reported using search parameters of "IS MISSING" or "NOT MISSING". <!-- PGDC-2530 // https://github.com/NCI-GDC/gdcapi/pull/524 -->
* Certain very large API requests will time out. It is recommended to break up very large requests into a series of smaller requests. <!-- PGDC-2411 -->


## v1.14.0

* __GDC Product__: Application Programming Interface (API)
* __Release Date__: April 23, 2018

### New Features and Changes

* Updated support of BCR XML submission for Next Generation Cancer Models <!--DAT-1207-->


### Bugs Fixed Since Last Release

* None

### Known Issues and Workarounds

* Fields are not counted as missing if parent field is also missing. This may occur with queries of nested fields in the Data Portal Advanced Search or an API query using a filter. This behavior could impact results reported using search parameters of "IS MISSING" or "NOT MISSING". <!-- PGDC-2530 // https://github.com/NCI-GDC/gdcapi/pull/524 -->
* Certain very large API requests will time out. It is recommended to break up very large requests into a series of smaller requests. <!-- PGDC-2411 -->


## v1.13.0

* __GDC Product__: Application Programming Interface (API)
* __Release Date__: February 15, 2018

### New Features and Changes

* Reduced number of submission portal timeouts by optimizing graphql API requests <!--API-317-->

### Bugs Fixed Since Last Release

* Fixed bug preventing submission of clinical data via BCR XML <!--SV-985-->

### Known Issues and Workarounds

* Fields are not counted as missing if parent field is also missing. This may occur with queries of nested fields in the Data Portal Advanced Search or an API query using a filter. This behavior could impact results reported using search parameters of "IS MISSING" or "NOT MISSING". <!-- PGDC-2530 // https://github.com/NCI-GDC/gdcapi/pull/524 -->
* Certain very large API requests will time out. It is recommended to break up very large requests into a series of smaller requests. <!-- PGDC-2411 -->

## v1.12.0

* __GDC Product__: Application Programming Interface (API)
Expand All @@ -15,7 +141,6 @@

### Known Issues and Workarounds

* API queries to the cases or files endpoints will not return anything if the "size" parameter is set to over 10,000. For API queries expected to return results larger than 10,000 cases/files, use the "from" parameter to break up the results. <!--SV-953-->
* Fields are not counted as missing if parent field is also missing. This may occur with queries of nested fields in the Data Portal Advanced Search or an API query using a filter. This behavior could impact results reported using search parameters of "IS MISSING" or "NOT MISSING". <!-- PGDC-2530 // https://github.com/NCI-GDC/gdcapi/pull/524 -->
* Certain very large API requests will time out. It is recommended to break up very large requests into a series of smaller requests. <!-- PGDC-2411 -->

Expand Down
34 changes: 21 additions & 13 deletions docs/API/Users_Guide/Appendix_A_Available_Fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ The GDC API's [search and retrieval endpoints](Search_and_Retrieval.md) provide
| --- |
| dbgap_accession_number |
| disease_type |
| name |
| name |
| primary_site |
| project_id |
| released |
| state |
| program.dbgap_accession_number |
| program.name |
| program.name |
| program.program_id |
| summary.case_count |
| summary.file_count |
| summary.file_size |
| summary.data_categories.case_count |
| summary.data_categories.data_category |
| summary.data_categories.file_count |
| summary.experimental_strategies.case_count |
| summary.experimental_strategies.case_count |
| summary.experimental_strategies.experimental_strategy |
| summary.experimental_strategies.file_count |

Expand All @@ -38,8 +38,8 @@ The GDC API's [search and retrieval endpoints](Search_and_Retrieval.md) provide
| aliquot_ids |
| analyte_ids |
| case_id |
| created_datetime |
| days_to_index |
| created_datetime |
| days_to_index |
| portion_ids |
| sample_ids |
| slide_ids |
Expand All @@ -50,7 +50,7 @@ The GDC API's [search and retrieval endpoints](Search_and_Retrieval.md) provide
| submitter_portion_ids |
| submitter_sample_ids |
| submitter_slide_ids |
| updated_datetime |
| updated_datetime |
| annotations.annotation_id |
| annotations.case_id |
| annotations.case_submitter_id |
Expand Down Expand Up @@ -122,7 +122,7 @@ The GDC API's [search and retrieval endpoints](Search_and_Retrieval.md) provide
| exposures.weight |
| exposures.years_smoked |
| family_histories.created_datetime |
| family_histories.family_history_id |
| family_histories.family_history_id |
| family_histories.relationship_age_at_diagnosis |
| family_histories.relationship_gender |
| family_histories.relationship_primary_diagnosis |
Expand Down Expand Up @@ -425,8 +425,8 @@ The GDC API's [search and retrieval endpoints](Search_and_Retrieval.md) provide
| files.cases.samples.portions.is_ffpe |
| files.cases.samples.portions.portion_id |
| files.cases.samples.portions.portion_number |
| files.cases.samples.portions.state |
| files.cases.samples.portions.submitter_id |
| files.cases.samples.portions.state |
| files.cases.samples.portions.submitter_id |
| files.cases.samples.portions.updated_datetime |
| files.cases.samples.portions.weight |
| files.cases.samples.portions.analytes.a260_a280_ratio |
Expand Down Expand Up @@ -470,9 +470,9 @@ The GDC API's [search and retrieval endpoints](Search_and_Retrieval.md) provide
| files.cases.samples.portions.analytes.aliquots.annotations.updated_datetime |
| files.cases.samples.portions.analytes.aliquots.center.center_id |
| files.cases.samples.portions.analytes.aliquots.center.center_type |
| files.cases.samples.portions.analytes.aliquots.center.code |
| files.cases.samples.portions.analytes.aliquots.center.name |
| files.cases.samples.portions.analytes.aliquots.center.namespace |
| files.cases.samples.portions.analytes.aliquots.center.code |
| files.cases.samples.portions.analytes.aliquots.center.name |
| files.cases.samples.portions.analytes.aliquots.center.namespace |
| files.cases.samples.portions.analytes.aliquots.center.short_name |
| files.cases.samples.portions.analytes.annotations.annotation_id |
| files.cases.samples.portions.analytes.annotations.case_id |
Expand Down Expand Up @@ -675,7 +675,7 @@ The GDC API's [search and retrieval endpoints](Search_and_Retrieval.md) provide
| samples.annotations.entity_id |
| samples.annotations.entity_submitter_id |
| samples.annotations.entity_type |
| samples.annotations.legacy_created_datetime |
| samples.annotations.legacy_creat
| samples.annotations.legacy_updated_datetime |
| samples.annotations.notes |
| samples.annotations.state |
Expand Down Expand Up @@ -1511,3 +1511,11 @@ The GDC API's [search and retrieval endpoints](Search_and_Retrieval.md) provide
| --- |
| project |
| project.program |

### GDC Conventions Supplemental
| Field Group Name |
| --- | --- |
| File size | Listed in bytes |
| Submitter id | String supplied by submitter |
| Datetime | Combination of date and time of day in the form [-]CCYY-MM-DDThh:mm:ss |
| Id | GDC supplied UUID ID |
Loading