This curated Wiki is just that, curated and a wiki, and as such relies upon the Fred Hutch research community itself to improve, expand and evolve over time. Because the content of this Wiki spans a wide range of research realms, we need and welcome contributions from a similarly wide range of researchers whether as novice reviewers for a topic outside of their particular domain of expertise or as expert contributors for those topics of most interest to them. No contribution is too little (or too large), and this section describes the various modes and types of contributions each researcher on the Fred Hutch campus can make to this effort.
The strength of the Wiki lies in it's collaborative and unified approach. To facilitate the curation of content seen in this site, we have employed a GitHub repository to which any Fred Hutch based researcher can be a part of and contribute to. The instructions for how to get started via GitHub are below as well as additional information about the ways to communicate with and participate in the Wiki Contributor team in other ways as well.
Go here, to see the current, and continually growing, style guide for content in this Wiki as decided upon by the Wiki Contributors group.
We manage the content of this site via a set of markdown files that contain long article-style text with an emphasis on the use of outline structures to allow related content to show up near each other but with the ability to use the automatically rendered Table of Contents to allow users to jump around the documents.
To edit one of the content-containing markdowns (see below regarding Repo structure for more info about where these markdowns are), the process for each user is:
- Create a branch off the master branch for your edits (do not fork the repo or create branches of branches). Consider naming the branch in such a way that indicates what domain the edits will primarily be in (such as "generation-typos" or "intro-to-rhino"). Avoid making branches with uninformative names if at all possible, as in order for your content to be merged into the master, it will need to be edited by others, and it is possible that others may have substantial content to add to your content. If the branches are named according to content being added (generally) then others can contribute to that content too.
- Commit your edits to existing markdowns as you go, and update from the master branch before continuing to work on your branch. You will reduce future conflicts if you get in the habit of updating from the master and committing frequently.
- Publish/push your branch to GitHub to save your work and let us know you're working on something.
- When you are done editing, create a pull request from your branch. Suggest reviewers based on the content of the edits. Request admin assistance if your content may be new and need to be hooked up to the sidebar or other web-specific needs (this is currently done by tagging vortexing or bmcgough for a review).
- Reviewers will sign off on edits by approving or providing comments on a pull request, ideally one "expert" and one "novice" based on field of expertise. Others may move your content to combine it with other work, or make edits that you may want to review as well. Keep an eye on your pull requests and comments on it in order to check back in if someone's edits need your review as well.
- An Admin will merge the pull request into the master and then any edits go live to the site here.
Afterwards: Please remember to make a markdown for yourself in our contributors directory so that we can give you credit for your contributions publicly on the site.
NOTE: All draft content should be stored in the draft folder until it is ready for publication, and then an admin will move it to where it needs to go if it is new content, OR the writer can move demo's themselves when they are ready to go live.
For new content: https://github.com/FredHutch/wiki/blob/master/draft/contentTemplate.md
For new contributor entries: https://github.com/FredHutch/wiki/blob/master/draft/contributorTemplate.md
Data Generation Content, organized with filenames that start with xxx_ based on what section they are intended to show up in the sidebar: https://github.com/FredHutch/wiki/tree/master/_generation
Bioinformatics Content, organized with filenames that start with xxx_ based on what section they are intended to show up in the sidebar: https://github.com/FredHutch/wiki/tree/master/_bioinformatics
Bioinformatics Demos (note all markdowns in this folder will be rendered as demo's): https://github.com/FredHutch/wiki/tree/master/_infdemos
Computing Content, organized with filenames that start with xxx_ based on what section they are intended to show up in the sidebar: https://github.com/FredHutch/wiki/tree/master/_computing
Computing Demos (note all markdowns in this folder will be rendered as demo's): https://github.com/FredHutch/wiki/tree/master/_compdemos
Contributors List (note all markdowns in this folder will be rendered as contributors): https://github.com/FredHutch/wiki/tree/master/_contributors
Computing: https://github.com/FredHutch/wiki/blob/master/computingdemos.md
Bioinformatics: https://github.com/FredHutch/wiki/blob/master/informaticsdemos.md
Contributors list: https://github.com/FredHutch/wiki/blob/master/contributorslist.md
Main website configuration file: https://github.com/FredHutch/wiki/blob/master/_config.yml
Navigation yml: https://github.com/FredHutch/wiki/tree/master/_data
Custom styling that overrides the remote theme: https://github.com/FredHutch/wiki/tree/master/assets/css
Header and footer configs: https://github.com/FredHutch/wiki/tree/master/_includes