Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

To do items for Spatial Allocator User Manual #1

Open
8 of 12 tasks
lizadams opened this issue Feb 15, 2017 · 3 comments
Open
8 of 12 tasks

To do items for Spatial Allocator User Manual #1

lizadams opened this issue Feb 15, 2017 · 3 comments

Comments

@lizadams
Copy link
Member

lizadams commented Feb 15, 2017

  • fix formatting of tables
  • update references to SMOKE User manual
    https://github.com/CMASCenter/Spatial-Allocator/blob/master/docs/User_Manual/SA_ch05_surrogate.md
    This currently mentions SMOKE 2.3, and we have released SMOKE 4.0
  • fix references to table of contents
  • review document and put code fences around sections that give examples on how to use command line options or to run the code.
  • review references to Sections of the document and put in appropriate links
    • look for http in the markdown and check to be sure it doesn't reference cmascenter
    • look for (# in the markdown and make sure all referenced sections exist
  • remove outdated reference to baronams for ioapi: http://www.baronams.com/products/ioapi/GRIDDESC.html
  • add code links for tables
  • use pandoc to convert remaining chapters by using this syntax pandoc -f html -t markdown_github -o test.md test.docx for more see: https://gist.github.com/vzvenyach/7278543
  • added tables 2 and 3 in SA Vector Chapter to replace embedded html pages proj_datums.html and proj_ellipses.html
  • search document for older earth radius specification 6370997.0 and replace with new one?
@lizadams lizadams changed the title references to older version of smoke in Surrogate Tools User Manual To do items for Surrogate Tools User Manual Feb 15, 2017
@lizadams lizadams changed the title To do items for Surrogate Tools User Manual To do items for Spatial Allocator User Manual Feb 15, 2017
@CMASCenter
Copy link
Collaborator

CMASCenter commented Feb 15, 2017

The vector tools are not in docx, they're are in HTML format. The Raster and Surrogate tools were the only documents in docx format. The Vector Tools section (and any other relevant sections on background, installation, etc) needs to be converted from HTML to Markdown. Skip the sections in the SA HTML guide on the raster and surrogate tools, as the content that we already have up here is newer than what's in the HTML.

Completed

@CMASCenter
Copy link
Collaborator

Update the extended TOC to use the new organization of the chapters. Review all chapters and compare to extended TOC, update TOC as needed.

@CMASCenter
Copy link
Collaborator

CMASCenter commented Mar 9, 2017

Check the descriptions of how to download the different satellite data sets in the Manual relative to the release notes in the repository. The release notes are updated and the manual needs to be synced with these.

Completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant