Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.26 KB

README.md

File metadata and controls

54 lines (34 loc) · 2.26 KB
Raw

Documentation

Incomplete and imperfect documentation today is better than perfect documentation that never materializes.

-Unknown

You will find here any documentation for the group. The preferred format is markdown. An excellent editor is available here: https://typora.io. Markdown is the best because it can be edited and viewed anywhere, including GitHub, is lightweight and simple. Typora supports LaTeX equations. Use Markdown.

Organisation of this repository

Filenames

There is structure to our chaos. Filenames are strictly enforced for clarity. Filenames must be CATEGORY-Title. Not everything is a good document name. CATGEORY is one of:

  1. GUIDE: Describes a system and how to use/troubleshoot it.
  2. HOWTO: Describes the exact steps to get something done, usually related to a computer but can be anything
  3. PROTOCOL: Describes the technical steps to complete a small task in the laboratory
  4. TECHREP: Explains or summarizes an article, book, or general concepts

A Title is anything informative and short.

Sources

  1. If using LaTeX, Pages, Word, microsoft Paint, excel whatever:
    1. Put the PDF doc on the start page.
    2. Put its editable file in a folder of the same name. Put this folder in folder 'Sources'.
  2. Markdown does not need a PDF

How to write for DCClab

Keeping documentation for the group is a difficult task if there are no standards. Hence, here are the various standards anyone must follow:

  1. Documents are in english

  2. Be clear, be concise but complete.

Editors and links with Github

LaTeX: How to link GitHub to your LaTex account

  1. Go to v2.overleaf.com.
  2. Log in with a Overleaf account (not Sharelatex).
  3. Click on 'New Project' --> 'Import from GitHub'.
  4. Follow the instructions.
  5. When asked, click on 'Request' next to all repositories you would like to have access to from your latex account. You should not need to request 'DCC-Lab' since Daniel has already given access to all people in DCC-Lab organization.
  6. Authorise access.
  7. Go back.
  8. Redo step 3.
  9. Now all your available repositories should be listed. Click on 'Import to ###' next to the repository you want.
  10. To push and pull, go to 'Menu' --> 'Sync' --> 'GitHub'.