update submit_data

memartone · Sep 15, 2018 · c1814b3 · c1814b3
1 parent 7dfcaac
commit c1814b3
Show file tree

Hide file tree

Showing 5 changed files with 74 additions and 11 deletions.
diff --git a/_data/sidebars/sparc_sidebar.yml b/_data/sidebars/sparc_sidebar.yml
@@ -10,6 +10,16 @@ entries:
     output: web, pdf
     folderitems:
 
-    - title: Introduction
+    - title: Information
       url: /introduction.html
       output: web, pdf
+    - title: Contributing to the documentation
+      url: /doc_contribute.html
+      output: web, pdf
+  - title: Submitting Data
+    output: web, pdf
+    folderitems:
+
+    - title: Submitting data to the SPARC resource
+      url: /submit_data.html
+      output: web, pdf
diff --git a/index.md b/index.md
@@ -3,18 +3,19 @@ title: "NIH SPARC Documentation"
 keywords: SPARC homepage
 tags: [home, getting_started]
 sidebar: sparc_sidebar
+toc: false
 permalink: index.html
-summary: This site provides information relevant to investigators funded by the NIH SPARC program.
+summary: Docs.sparc.science provides information relevant to investigators funded by the NIH SPARC program. 
 ---
 
-## Using the documentation
+## Introduction
 
-This documentation provides information relevant to SPARC investigators and anyone interested in understanding the data workflow and policies of the SPARC project.
+This documentation provides information relevant to SPARC investigators and anyone interested in understanding the data workflow and policies of the SPARC project. The information on this site is managed by the SPARC Data Resource Center (DRC) and content might change significantly over time. Please contact the DAT core if you have suggestions for content or if you want to actively participate in developing documentation hosted on this site.
 
 
 ## Contributing to the documentation
 
-This documentation is created by the SPARC community and provides information related to the various aspects of the SPARC program. The sourcecode for this documentation site is available on Github [https://github.com/Blackfynn/docs.sparc.science](https://github.com/Blackfynn/docs.sparc.science) and anyone can generate a pull request to make changes to this documentation site. 
+This documentation is created by the SPARC community and provides information related to the various aspects of the SPARC program. The sourcecode for this documentation site is available on Github [https://github.com/Blackfynn/docs.sparc.science](https://github.com/Blackfynn/docs.sparc.science) and anyone can generate a pull request to make changes to this documentation site. More information [here](doc_contribute.html).
 
 
 
diff --git a/pages/dat_core/submit_data.md b/pages/dat_core/submit_data.md
@@ -0,0 +1,13 @@
+---
+title: "Submitting data to the SPARC resource"
+keywords: documentation, github
+sidebar: sparc_sidebar
+toc: false
+permalink: submit_data.html
+summary: (DRAFT) This pages outlines the workflow for submitting data to the SPARC DAT-Core. 
+folder: general
+---
+
+This document is currently being drafted
+
+### Information soon...
diff --git a/pages/general/doc_contribute.md b/pages/general/doc_contribute.md
@@ -0,0 +1,36 @@
+---
+title: "Contributing to the documentation site"
+keywords: documentation, github
+sidebar: sparc_sidebar
+toc: false
+permalink: doc_contribute.html
+summary: This document outlines how you can contribute to this website. Anyone can create a branch of this repository and add or modify any of the pages for this documentation by submitting a pull request to the master branch of the code. 
+folder: general
+---
+
+## Contributing to the SPARC Documentation website
+This document outlines how you can contribute to this website. This website is generated using [Jekyll](https://jekyllrb.com/) and the source-code is publically available here: [https://github.com/Blackfynn/docs.sparc.science](https://github.com/Blackfynn/docs.sparc.science)
+
+Anyone can create a branch of this repository and add or modify any of the pages for this documentation by submitting a pull request to the master branch of the code. The DAT-Core manages the repository and will pull in any changes after they are validated.
+
+## Workflow for adding documentation to the site
+To submit a pull request with updates to the documentation site:
+1. Create a your own branch from the GitHub repository. 
+2. Install Jekyll on your computer if you want to locally test the updates.
+3. Add, or edit pages following the guidelines below.
+4. Commit your changes to your branch and push to GitHub.
+5. Submit a pull request with a description of your changes.
+6. The DAT-Core will merge your changes into the master branch which will update https://docs.sparc.science.
+
+## Editing the documentation and testing the documentation locally
+The SPARC documentation site is using the Jekyll Doc Theme. Full documentation for this theme is located here: [https://idratherbewriting.com/documentation-theme-jekyll/](https://idratherbewriting.com/documentation-theme-jekyll/). Follow the instructions in the link to setup Jekyll on your computer to locally test any changes that you make to the documentation site. The theme documentation also provides indepth instructions on how to make changes to the site. 
+
+The theme is quite flexible. To keep the SPARC documentation site clean, please follow the following guidelines:
+1. Only use Markdown to format your pages
+2. Store pages in the 'pages' folder and create a meaningful hierarchy of folders if necessary
+3. Store images in the 'images' folder
+4. Do not create any new sidebars. Use the '_data/sidebars/sparc_sidebar.yml' sidebar.
+5. Do not add any top-navigation.
+
+## Questions
+Contact the DAT-Core if you have any questions or suggestions. 
diff --git a/pages/general/introduction.md b/pages/general/introduction.md
@@ -1,15 +1,18 @@
 ---
-title: Test page for SPARC
+title: SPARC DRC Contact information
 keywords: SPARC 
-summary: "This is a sample document for SPARC"
+toc: false
+summary: "(DRAFT) How to reach the various components of the Data Resource Center"
 sidebar: sparc_sidebar
 permalink: introduction.html
-folder: sparc
+folder: general
 ---
 
-## SPARC
+### DAT-Core (Data Core):
+[email protected] or through the Blackfynn web application for technical support
 
-"Lorem Ipsum" is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
+### SIM-Core (Simulation Core):
 
-It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).
+
+### MAP-Core (Mapping Core):