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

Hotfix for nhsn doc #1581

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Hotfix for nhsn doc #1581

wants to merge 3 commits into from

Conversation

nmdefries
Copy link
Contributor

@nmdefries nmdefries commented Jan 24, 2025

addresses #1579

Summary:

New NHSN doc page was titled with NSSP info.

Prerequisites:

  • Unless it is a documentation hotfix it should be merged against the dev branch
  • Branch is up-to-date with the branch to be merged with, i.e. dev
  • Build is successful
  • Code is cleaned up and formatted

@nmdefries nmdefries requested a review from aysim319 January 24, 2025 23:49
@nmdefries
Copy link
Contributor Author

Maybe this is considered a hotfix and should be merged directly to main?

aysim319
aysim319 previously approved these changes Jan 26, 2025
@aysim319 aysim319 requested review from carlynvandyke and removed request for carlynvandyke January 27, 2025 16:24
@aysim319 aysim319 changed the title New title for NHSN page Hotfix for nhsn doc Jan 27, 2025
@aysim319 aysim319 linked an issue Jan 27, 2025 that may be closed by this pull request
@aysim319 aysim319 changed the base branch from dev to main January 27, 2025 16:42
@carlynvandyke
Copy link

The name in the Data Sources and Signals menu is also wrong- can we change from "NHSN ED Visits" to "NHSN Hospital Respiratory Data" before merging?

carlynvandyke
carlynvandyke previously approved these changes Jan 27, 2025
Copy link

@carlynvandyke carlynvandyke left a comment

Choose a reason for hiding this comment

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

🏄‍♀️

aysim319
aysim319 previously approved these changes Jan 27, 2025
Copy link
Collaborator

@melange396 melange396 left a comment

Choose a reason for hiding this comment

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

we should not merge this directly into the main branch, as there could be a number of unintended consequences. lets merge into dev instead and then go through a regular release process later.

parent: Data Sources and Signals
grand_parent: Main Endpoint (COVIDcast)
nav_order: 1
---
# National Syndromic Surveillance Program Emergency Department Visits
# National Healthcare Safety Network Respiratory Hospitalizations (Continuation of [HHS]((see [date format docs](../hhs.md)))
Copy link
Collaborator

Choose a reason for hiding this comment

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

i dont know if i would put this here. first, its a little weird to have a link in the title heading. second, it could be misleading because the document uses "HHS" in a different context (for geographic regions), and this would be better mentioned with a little more detail in the "Overview" and/or "Limitations" sections. neither is "wrong"

Copy link
Contributor

Choose a reason for hiding this comment

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

the ticket mentioned that we should say more prominently that this data source is the continuation of the old HHS source. @carlynvandyke thoughts? maybe put it in the overview?

Choose a reason for hiding this comment

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

Yeah, I think George's comment makes sense. I'm going to draft some language to put in the overview.

@melange396 melange396 changed the base branch from main to dev January 29, 2025 03:34
@melange396 melange396 dismissed stale reviews from aysim319 and carlynvandyke January 29, 2025 03:34

The base branch was changed.

@melange396 melange396 changed the base branch from dev to main January 29, 2025 22:16
@melange396 melange396 changed the base branch from main to dev January 29, 2025 22:16
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

Successfully merging this pull request may close these issues.

NHSN documentation needs cleaning
4 participants