search

LSSTDESC / ComputingInfrastructure

Gathering place for CI - Computing and Infrastructure - issues
3 stars 1 forks source link

Create LSST DESC Note template #25

Closed heather999 closed 8 years ago

heather999 commented 8 years ago

First goal for Hack Day! Create a template MD file that will represent a standardized LSST DESC Note. The content may contain our first stab at general guidelines.

heather999 commented 8 years ago

If you have a moment @drphilmarshall, please see the new LSST_DESC_Notes directory under doc. I'm a little faster using rST, so I started there. I can create another template in markdown as well. Also take a peek at rough guidelines under the guidelines subdirectory and edit at will! As Hack Day is passing quickly, I'm going to try to set up Travis and see if I can manage to make a PDF out of this.

drphilmarshall commented 8 years ago

This is a great start, thanks Heather! I will iterate on the template when I am back from vacation (week of August 1) - good idea to switch focus to the processing-type issues in the meantime.

BTW Watchers: pull requests on the design and content of the guidelines = template are most welcome!

drphilmarshall commented 8 years ago

I did some iteration, PR to follow. In the meantime, I found this useful-looking to-do list. We should issue parts of this if we have not done so already!

To Do

  • `Create setup script #28
  • Iterate on the guidelines
  • Further test the suitability of Pandoc for conversion into PDF, and take another look at Sphinx
  • Enable travis-ci to automate creation of PDF and population of GitHub-pages
drphilmarshall commented 8 years ago

OK, I think the template rst file in PR #29 is a good enough start. This issue will be closed when that PR is merged.