-
Notifications
You must be signed in to change notification settings - Fork 65
Web Committee 201805 Minutes
Heather Wilson edited this page May 10, 2018
·
3 revisions
- Onboarding document - Heather and Laurel will kick off
- Newsletter - turn central story into overview about Web Committee - https://docs.google.com/document/d/1tkr10ZRNnfS768wGc5wdOyuGRfN40kVv-UqdkIKour0/edit?usp=sharing
- Documentation
-
- Separate repo in Github - https://github.com/coral-erm/documentation
-
- 2 folders:
-
-
- Source: files for documentation - markdown format - config = python - RST - python file -
-
-
-
-
- get generic Markdown editor (markdown pad = windows but there are tons) -=
-
-
-
-
-
- readthedocs = reads documentation in Github to auto post to website (http://docs.coral-erm.org/en/latest/) using webhooks - auto indexes and updates versions based on informaiton in left corner
-
-
-
-
-
-
- Create a Github account
-
-
-
-
-
-
-
- Send Scott Github ID
-
-
-
-
-
-
-
- Ignore readthedocs unless you want to make edits to the CSS (which lives on Github)
-
-
-
-
- Style Guide: http://docs.coral-erm.org/en/latest/docstyleguide.html - guide to help with the markdown process
-
-
- Try to keep the images in the same directory
-
-
-
- Edits - Follow the instrucitions to change the branch name then edit the files and add the merge and change details. Pull request created - no conflicts? You can merge (or have someone else merge)
-
-
-
- If these measures are too complicated, you can email it back to the web committee
-