-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20 from hubmapconsortium/DocDev
Pulling in files from Doc dev branch
- Loading branch information
Showing
7 changed files
with
354 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| <div id="HuBMAP-Docs-Sidenav" class="sidenav"> | ||
| <a href="javascript:void(0)" class="closebtn" onclick="closeNav()">×</a> | ||
| <a href="#">Developers</a> | ||
| <a href="#">Data Submitters</a> | ||
| <a href="#">Consortium Members</a> | ||
| </div> | ||
|
|
||
| <!-- Use any element to open the sidenav --> | ||
| <span onclick="openNav()">open</span> | ||
|
|
||
| <!-- Add all page content inside this div if you want the side nav to push page content to the right (not used if you only want the sidenav to sit on top of the page --> | ||
|
|
||
| <div id="main"> | ||
|
|
||
| # Developers | ||
|
|
||
| <details> | ||
| <summary><a href="https://hubmapconsortium.org/member-portal/developer-information/">Developer Tools</a> (linked from the HuBMAP Consortium website):</summary> | ||
| <ul> | ||
| <li>HIVE Infrastructure accounts</li> | ||
| <li>Access to HuBMAP AWS</li> | ||
| <li>DockerHub</li> | ||
| <li>Access to HuBMAP Folders via Globus</li> | ||
| <li>HuBMAP workspace in GitHub</li> <li>HuBMAP workspace in protocols.io</li> | ||
| <li>Data Authentication</li> | ||
| </ul></details> | ||
| - HuBMAP Application-specific APIs (**Not intended for use by external developers or other external users**): | ||
| - <a href="https://smart-api.info/ui/5a6bea1158d2652743c7a201fdb1c44d">Ingest API</a>: Supports writing data and metadata to HuBMAP, used by both TMCs and the HIVE. Links to the SmartAPI site where this API is registered as well as documentation for the API. | ||
| - <a href="https://github.com/hubmapconsortium/uuid-api">UUID API</a>: Supports donor and tissue sample registration, data submission, and collection of provenance information via the Ingest UI. Links to GitHub documentation for this API. | ||
| - <a href="https://smart-api.info/ui/96e5b5c0b0efeef5b93ea98ac2794837">Ontology (UBKG) API</a>: Accesses an instance of a [neo4j] Unified Biomedical Knowledge Graph (UBKG). | ||
| - This UBKG links infomation from a variety of biomedical vocabulary systems. | ||
| - The HuBMAP UBKG instance includes HuBMAP’s application ontology that represents the HuBMAP operational model. | ||
| - Links to the SmartAPI site where this API is registered as well as documentation for the API. | ||
|
|
||
| # Data Submitters | ||
| - <a href="https://docs.hubmapconsortium.org/data-submission/">Data Submission Guide</a>: Documents the key steps for TMCs, Assay teams, and others who upload data to the HuBMAP. | ||
| - <a href="https://docs.hubmapconsortium.org/metadata">Metadata/data schemas</a>: HuBMAP metadata documentation and submission specifications. | ||
| - See the <a href="https://hubmapconsortium.github.io/ingest-validation-tools/">HuBMAP Data Upload Guidelines</a> for the latest assay metadata options and specifications. | ||
| - <a href="https://metadatavalidator.metadatacenter.org/">Metadata Spreadsheet Validator</a>: Use this tool to validate your metadata spreadsheet (template). | ||
| - <a href="https://metadatacenter.github.io/spreadsheet-validator-docs/">Help documentation</a> for the Metadata Spreadsheet Validator. | ||
| - <a href="https://docs.google.com/forms/d/14tBFAfMy82qQGAR1ECIljCJDaHxQUS-o6z0526jpUuQ/edit?ts=662feb8b">HuBMAP Microscope Metadata entry form</a>: Submit Microscopy Metadata in compliance with the NBO-Q metadata model. | ||
| - <a href="https://docs.google.com/spreadsheets/d/1Ju1_mvqTk1B8I8Ot6EKFKZuQbwkJy4NwzVgwoITWWYw/edit?gid=0#gid=0">HuBMAP Microscope Hardware Collection</a>: List of Microscopy Metadata collected to date. | ||
|
|
||
| # Consortium Members | ||
| - <a href="https://hubmapconsortium.org/member-portal/">HuBMAP Member Portal</a>: Find information about how to navigate the consortium, including the calendar, member directory, etc. | ||
| - SOPs | ||
| - <a href="https://hubmapttps://hubmapconsortium.org/working-groups/">Governance</a>: The HuBMAP Steering Committee and Working Groups. | ||
| - <a href="https://drive.google.com/drive/folders/1jbgzo_MpA7lVv9rmmgxP1Zfuegwis31E">HuBMAP Consortium Google Drive</a>: A shared resource. | ||
| - <a h ref="https://hubmapconsortium.org/guide-doc-management">Document Management Guide</a>: For the HuBMAP Consortium Google Drive. | ||
| - <a href="https://hubmapconsortium.org/hubmap-calendar/">HuBMAP Calendar</a>: A web calendar that combines all shared, internal Consortium events. | ||
| - <a href="https://docs.google.com/document/d/e/2PACX-1vRyir3ozru4TB3SU79b-_psN3BFxr6BsWORnUFP53_jU1vQAAQe1feRSgXTWqHfrLfqo1NgOHNvgS78/pub">Using Google Groups with Google Calendar</a> | ||
| - other Resources | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>HuBMAP Member Sitemap</title> | ||
| </head> | ||
| <body> | ||
| <h1>HuBMAP Documentation Sitemap</h1> | ||
|
|
||
| <h2>Developers</h2> | ||
| <h3>Developer Tools</h3> | ||
| Developers may need access to these tools for specific development work: | ||
| <ul> | ||
| <li><b>AWS</b>: Create a <a href="mailto:help@hubmapconsortium.org">Helpdesk ticket</a> to request access to HuBMAP AWS.</li> | ||
| <li><b>Data Authentication</b>: See a <a href="https://docs.google.com/presentation/d/1vjWMLlJIgBiIpzmHj00eNBzfDF6dTa2Ser7jh4924YQ">diagram of data flow</a> through the HuBMAP authentication process.</li> | ||
| <li><b>DockerHub</b>: HuBMAP uses DockerHub to share containers. </li> | ||
| <ul> | ||
| <li>Create a <a href="mailto:help@hubmapconsortium.org">Helpdesk ticket</a> to request access to the <a href="https://hub.docker.com/u/hubmap">HuBMAP organization</a> on DockerHub. </li> | ||
| <li>You can also <a href="https://hub.docker.com/r/hubmap/incubator">contribute new containers</a> to the HuBMAP DockerHub.</li> | ||
| </ul> | ||
| <li><a href="https://github.com/hubmapconsortium"><b>GitHub HuBMAP workspace</b></a>: HuBMAP's GitHub workspace includes repos for tools related to the Consortium's work.</li> | ||
| <li><b>Globus Folders</b>: You might need access to HuBMAP data in Globus folders. Globus also provides access to the HuBMAP ingest portal.</li> | ||
| <ul> | ||
| <li>Your Globus identity must be associated with an institution in the dropdown list on this <a href="https://app.globus.org">Globus page</a>.</li> | ||
| <li>You cannot use a gmail or an ORCID Globus identity for HuBMAP. NIH eRA Commons accounts are also no longer acceptable.</li> | ||
| <li>Learn how to get <a href="https://hubmapconsortium.org/collaboration-tools/#globus">Globus access</a>.</li> | ||
| </ul> | ||
| <li><b>HIVE Infrastructure account</b>: Use this <a href="https://grants.psc.edu/cgi-bin/hubmap/add_users.pl">application form</a> to request an account. Tips for <a href="https://hubmapconsortium.org/using-the-hive-infrastructure/">using the HIVE infrastructure</a>.</li> | ||
| <ul> | ||
| <li>Once approved, you will be contacted via email with account information and login instructions.</li> | ||
| </ul> | ||
| <li><b>Protocols.io</b>: HuBMAP requires that all protocols be publicly available through the <a href="https://www.protocols.io/workspaces/human-biomolecular-atlas-program-hubmap-method-development">HuBMAP Method Development Community</a> on protocols.io.</li> | ||
| <ul> | ||
| <li>You must be a member of this workspace to publish protocols there. <a href="https://hubmapconsortium.org/collaboration-tools/#protocols">Join</a> the HuBMAP Community on protocols.io.</li> | ||
| </ul> | ||
| </ul> | ||
| </ul> | ||
|
|
||
| <h3>Application-specific APIs</h3> | ||
| These HuBMAP APIs are <i>not intended</i> for use by external developers or other external users. | ||
| <ul> | ||
| <li><a href="https://smart-api.info/ui/5a6bea1158d2652743c7a201fdb1c44d"><b>Ingest API</b></a>: Supports writing data and metadata to HuBMAP, used by both TMCs and the HIVE. Links to the SmartAPI site where this API is registered as well as documentation for the API.</li> | ||
| <li><a href="https://github.com/hubmapconsortium/uuid-api"><b>UUID API</b></a>: Supports donor and tissue sample registration, data submission, and collection of provenance information via the Ingest UI. Links to GitHub documentation for this API.</li> | ||
| <li><a href="https://smart-api.info/ui/96e5b5c0b0efeef5b93ea98ac2794837"><b>Ontology (UBKG) API</b></a>: Accesses an instance of a [neo4j] Unified Biomedical Knowledge Graph (UBKG).</li> | ||
| <ul> | ||
| <li>This UBKG links infomation from a variety of biomedical vocabulary systems.</li> | ||
| <li>The HuBMAP UBKG instance includes HuBMAP’s application ontology that represents the HuBMAP operational model.</li> | ||
| <li>Links to the SmartAPI site where this API is registered as well as documentation for the API.</li> | ||
| </ul> | ||
| </ul> | ||
|
|
||
| <h2>Data Submitters</h2> | ||
| <ul> | ||
| <li><a href="https://docs.hubmapconsortium.org/data-submission/"><b>Data Submission Guide</b></a>: Documents the key steps for TMCs, Assay teams, and others who upload data to the HuBMAP.</li> | ||
| <li><a href="https://docs.hubmapconsortium.org/metadata"><b>Metadata/data schemas</b></a>: HuBMAP metadata documentation and submission specifications.</li> | ||
| <ul> | ||
| <li>See the <a href="https://hubmapconsortium.github.io/ingest-validation-tools/">HuBMAP Data Upload Guidelines</a> for the latest assay metadata options and specifications.</li> | ||
| </ul> | ||
| <li><a href="https://metadatavalidator.metadatacenter.org/"><b>Metadata Spreadsheet Validator</b></a>: Use this tool to validate your metadata spreadsheet (template).</li> | ||
| <ul> | ||
| <li><a href="https://metadatacenter.github.io/spreadsheet-validator-docs/">Help documentation</a> for the Metadata Spreadsheet Validator.</li> | ||
| </ul> | ||
| <li><a href="https://docs.google.com/forms/d/14tBFAfMy82qQGAR1ECIljCJDaHxQUS-o6z0526jpUuQ/edit?ts=662feb8b"><b>HuBMAP Microscope Metadata entry form</b></a>: Submit Microscopy Metadata in compliance with the NBO-Q metadata model.</li> | ||
| <ul> | ||
| <li><a href="https://docs.google.com/spreadsheets/d/1Ju1_mvqTk1B8I8Ot6EKFKZuQbwkJy4NwzVgwoITWWYw/edit?gid=0#gid=0">HuBMAP Microscope Hardware Collection</a>: List of Microscopy Metadata collected to date.</li> | ||
| </ul> | ||
| </ul> | ||
|
|
||
| <h2>General Links</h2> | ||
| <ul> | ||
| <li><a href="https://hubmapconsortium.org/member-portal/"><b>HuBMAP Member Portal</b></a>: Find information about how to navigate the consortium, including the calendar, member directory, etc.</li> | ||
| <ul> | ||
| <li><a href="https://hubmapttps://hubmapconsortium.org/working-groups/"><b>Governance</b></a>: The HuBMAP Steering Committee and Working Groups.</li> | ||
| <li><a href="https://drive.google.com/drive/folders/1jbgzo_MpA7lVv9rmmgxP1Zfuegwis31E"><b>HuBMAP Consortium Google Drive</b></a>: A shared resource.</li> | ||
| <ul> | ||
| <li><a href="https://hubmapconsortium.org/guide-doc-management">Document Management Guide</a>: For the HuBMAP Consortium Google Drive.</li> | ||
| </ul> | ||
| <li><a href="https://hubmapconsortium.org/hubmap-calendar/"><b>HuBMAP Calendar</b></a>: A web calendar that combines all shared, internal Consortium events.</li> | ||
| <ul> | ||
| <li><a href="https://docs.google.com/document/d/e/2PACX-1vRyir3ozru4TB3SU79b-_psN3BFxr6BsWORnUFP53_jU1vQAAQe1feRSgXTWqHfrLfqo1NgOHNvgS78/pub">Using Google Groups with Google Calendar</a></li> | ||
| </ul> | ||
| </ul> | ||
| <li>SOPs</li> | ||
| <li>Other Resources</li> | ||
| </ul> | ||
| </ul> | ||
|
|
||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>HuBMAP Non-Member Sitemap</title> | ||
| </head> | ||
| <body> | ||
| <h1>HuBMAP Documentation Sitemap</h1> | ||
|
|
||
| <h2>General Links</h2> | ||
| <ul> | ||
| <li><a href="https://hubmapconsortium.org/member-portal/">HuBMAP Member Portal</a>: Find information about how to navigate the consortium, including the calendar, member directory, etc.</li> | ||
| <ul> | ||
| <li>SOPs</li> | ||
| <li><a href="https://hubmapttps://hubmapconsortium.org/working-groups/">Governance</a>: The HuBMAP Steering Committee and Working Groups.</li> | ||
| <li><a href="https://drive.google.com/drive/folders/1jbgzo_MpA7lVv9rmmgxP1Zfuegwis31E">HuBMAP Consortium Google Drive</a>: A shared resource.</li> | ||
| <ul> | ||
| <li><a href="https://hubmapconsortium.org/guide-doc-management">Document Management Guide</a>: For the HuBMAP Consortium Google Drive.</li> | ||
| </ul> | ||
| <li><a href="https://hubmapconsortium.org/hubmap-calendar/">HuBMAP Calendar</a>: A web calendar that combines all shared, internal Consortium events.</li> | ||
| <ul> | ||
| <li><a href="https://docs.google.com/document/d/e/2PACX-1vRyir3ozru4TB3SU79b-_psN3BFxr6BsWORnUFP53_jU1vQAAQe1feRSgXTWqHfrLfqo1NgOHNvgS78/pub">Using Google Groups with Google Calendar</a></li> | ||
| </ul> | ||
| <li>other Resources</li> | ||
| </ul> | ||
| </ul> | ||
| </ul> | ||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.