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

Create viz.yaml storm outline #2

Open
aappling-usgs opened this issue Oct 2, 2017 · 0 comments
Open

Create viz.yaml storm outline #2

aappling-usgs opened this issue Oct 2, 2017 · 0 comments

Comments

@aappling-usgs
Copy link
Member

aappling-usgs commented Oct 2, 2017

Populate the viz.yaml from #1 with core components expected for every storm. Use this opportunity to revise and clarify the viz.yaml organization.

  • Every item name should be extremely clear and intuitive to newcomers.
  • There should be no vestigial viz.yaml comments, and there should be new comments where these would aid in use of the template. Maybe there's even a 1-sentence comment describing each viz item, to ease adoption of the template by new teammates.
  • Organize the viz items in a very sensible/chronological order.
  • Use our new vizlab style guide in naming elements, functions, and scripts.

Components (check and revise this list; look to recent vizzies to establish expected inputs and outputs of each viz item):

  • parameters: date range, etc.
  • base map
  • gage locations
  • flood stage info for each site
  • timesteps
  • storm track
  • precip
  • stage timeseries data
  • legend
  • sparklines
  • caption
  • social media
  • header and footer
  • thumbnails
  • GIF
  • js resources (animate, lightbox)
  • css files
  • play and loading icons

Distinguish mobile from desktop, as we have in recent vizzies. Mobile first!

Placeholders:

  • leave empty, or with TODO, items that will be new for each vizzie. e.g. overall viz id, name, date, publish-date, path, analytics-id, description, some keywords. it should be really hard to accidentally forget to update any of these when forking and using this template.
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