Coder Social home page Coder Social logo

greenelab / onboarding Goto Github PK

View Code? Open in Web Editor NEW
31.0 14.0 21.0 3.26 MB

Onboarding materials for the Greene Lab

Home Page: https://git.io/vbFO9

License: Creative Commons Zero v1.0 Universal

onboarding greenelab guidelines upenn lab lab-carpentry

onboarding's Introduction

Greene Lab Onboarding Repository

The repository is home to the onboarding information for the Greene Lab at the University of Colorado School of Medicine. See onboarding.md for the onboarding information.

Contributing

To propose a change, submit a pull request. Consider the following goals of the onboarding document:

  • Simple: Use straightforward language and avoid jargon.
  • Concise: The document should be readable in a single sitting.
  • Specific: It should be targeted to the lab in question.
  • Enforceable: Failure to meet expectations should have consequences.
  • Living: The document is expected to change.
  • Local Resources: (should this be part of a separate document?)

License

This repository is dedicated to the public domain. See the LICENSE file for more details.

onboarding's People

Contributors

ajlee21 avatar brettbj avatar cgreene avatar danich1 avatar dhimmel avatar dongbohu avatar gwaybio avatar ivichadriana avatar jaclyn-taroni avatar kurtwheeler avatar matthewturk avatar mhuyck avatar miltondp avatar rando2 avatar rrosh avatar rzelayafavila avatar taylorreiter avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

onboarding's Issues

readthedocs & switching to markdown source from reStructuredText

I'm planning on how to make the migration from rst to md.

Are we still using http://greenelab-onboarding.readthedocs.io/en/latest/? How/where is readthedocs configured?

I think we should be able to use markdown with readthedocs, see http://docs.readthedocs.io/en/latest/getting_started.html#in-markdown. However, I'm not sure RTD is actually desirable here:

  • the GitHub interface is fine for browsing rendered READMEs.
  • you lose the close connection to the source code
  • it adds complexity

Updates to technology info

I've been meeting to add some new content based on my experience getting started, but since I don't know what I don't know, I'm going to make a list of a few ideas so people can tell me if they're wrong, and then I'll create a PR when I have some free time!

  • Which slack channels to join (lab-meeting, wins, journalclub, any preferred programming languages, possibly others?)
  • Social guidelines for slack (e.g., no gifs in general expect during holidays or pandemics?)
  • Lab prefers slack dms for informal communication rather than email
  • For GitHub, one sentence per line in documentation
  • Teleconferencing software: Casey has uberconference, Penn gives us BlueJeans

The above and then any suggestions (e.g., other slack channels) I'll move into a PR hopefully sometime this week!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.