Skip to content

Redo landing page and intro doc #230

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 19 commits into from
Dec 11, 2023
Merged

Redo landing page and intro doc #230

merged 19 commits into from
Dec 11, 2023

Conversation

nmdefries
Copy link
Contributor

@nmdefries nmdefries commented Dec 8, 2023 •
edited
Loading

  • Add more descriptive info to landing page
  • Add citation and licensing info to landing page
  • Move installation, setup, and basic usage from landing page to intro vignette
  • Move signal discovery and example "other" endpoint calls from intro vignette to new signal discovery vignette
  • Add geo info to intro vignette
  • Add examples of geo specification to intro vignette
  • Add examples of as_of specification to intro vignette
  • Add stub versioned data vignette

Partially addresses #212

nmdefries
nmdefries commented Dec 8, 2023
View reviewed changes
vignettes/epidatr.Rmd
## Advanced Usage (Experimental)
_Note_ that private endpoints (i.e. those prefixed with `pvt_`) require a
separate key that needs to be passed as an argument. These endpoints require
specific data use agreements to access.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to include more info here. How can users get access to private endpoints? Do we have a page or contact email for that?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never found that information anywhere. @brookslogan do you know?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't. Pre-COVID I don't think there was even a procedure, but I'm not sure if there is one now.

Context: Pre-COVID I think most of these we probably didn't even have permission to re-share. Many were for internal use (e.g., feeding into ILI-Nearby) + potentially sharing back/visualizing to the providers or maybe very limited pre-agreed-upon third parties (and even this last possibility I'm not sure ever actually happened). One that I know of (NoroSTAT) was private just for testing purposes; it requires revival work now though so I'm not sure there's a point in broadening access.

Copy link
Contributor Author

@nmdefries nmdefries Dec 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Appreciate the context, Logan. Will look into this and address separately.

Base automatically changed from ndefries/doc-changelog to dev December 8, 2023 21:11
@dshemetov
Copy link
Contributor

dshemetov commented Dec 8, 2023 •
edited
Loading

Are there parts you would like specific feedback on here? I've read so many variations on these docs that it's hard for me to focus and make helpful suggestions. If you don't need specific feedback, I'm happy to just trust your taste in re-organizing and clarifying our docs.

@nmdefries
Copy link
Contributor Author

No specific feedback desired. Give as much or as little feedback as you want.

The changes here can be summarized as:

  • give contextual, not usage, info on the landing page
  • add more, shorter vignettes
  • add more depth and specifics on usage

dshemetov
dshemetov approved these changes Dec 11, 2023
View reviewed changes
Copy link
Contributor

@dshemetov dshemetov left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trusting Nat's reorganization and edits here. If there are typos, small edits needed, we can catch them after this is merged into dev and we work on other PRs for the next version.

@nmdefries nmdefries merged commit 028ff8c into dev Dec 11, 2023
@nmdefries nmdefries deleted the ndefries/web-intro-pages branch December 11, 2023 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dshemetov dshemetov dshemetov approved these changes

@brookslogan brookslogan Awaiting requested review from brookslogan brookslogan is a code owner

@dsweber2 dsweber2 Awaiting requested review from dsweber2 dsweber2 is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nmdefries @dshemetov @brookslogan