Skip to content

add tutorials and links to docs, examples, READMEs  #3

Open
@dlebauer

Description

@dlebauer

Now that we are releasing data, it will be helpful for you to provide 'quick start' tutorials that illustrate the work that you have been doing. Many of you have already written these. At a minimum please cross-reference to existing documentation, tutorials, readme's in the README file of the tutorials repository https://github.com/terraref/tutorials/edit/master/README.md

This Wednesday is the deadline for contributions to the tutorials and documentation that we will be introducing to people at Phenome 2017 beginning Friday. I look forward to highlighting what our team has done. This repository is a place for tutorials + links to further reading.

If there is something awesome that you want others to know about, here are some ways you can contribute

Cross-reference, revise

  • (easy) if you have already written documentation or well documented code (e.g. README's / documentation), please provide links + summaries in the repository README. Like "See the readme for an overview of using XYZ"
  • (easy-med) go through what we have, learn from, and improve it (will be increasingly useful as the week progresses)

Update material

  • (med) If you / your group has existing examples (e.g. in documentation or readmes) please make sure that they work with our existing infrastructure, provide links to current sample datasets

Contribute new material

  • (med) Contribute to or create new tutorials that can be self guided, with screenshots and / or code snippets. These do not have to be comprehensive - Manageable snippits that take 10 minutes are very useful and may only take an hour to write.
  • (hard) If you have more time, see https://software-carpentry.org/lessons/ for great examples, and this repository for the alpha-versions that many are already working on.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions