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

#16730 timezone enrichment documentation #16779

Merged
merged 8 commits into from
Dec 17, 2024

Conversation

the-andrew
Copy link
Collaborator

@the-andrew the-andrew commented Dec 11, 2024

Update docs to mentions changes for time zone conversion translation to use enrichment schema

If you are suggesting a fix for a currently exploitable issue, please disclose the issue to the prime-reportstream team directly outside of GitHub instead of filing a PR, so we may immediately patch the affected systems before a disclosure. See SECURITY.md/Reporting a Vulnerability for more information.

Test Steps:

  1. Include steps to test these changes

Changes

  • prime-router/docs/onboarding-users/migrating-receivers.md
    Added note for convertDateTimeToReceiverLocalTimezone and example config
  • prime-router/docs/onboarding-users/receivers.md
    Added note for example schema
  • prime-router/docs/universal-pipeline/translate.md
    Added note and linkback to new migrating-receivers.md note.

Checklist

Testing

  • Tested locally?
  • Ran ./prime test or ./gradlew testSmoke against local Docker ReportStream container?
  • (For Changes to /frontend-react/...) Ran npm run lint:write?
  • Added tests?

Process

  • Are there licensing issues with any new dependencies introduced?
  • Includes a summary of what a code reviewer should test/verify?
  • Updated the release notes?
  • Database changes are submitted as a separate PR?
  • DevOps team has been notified if PR requires ops support?

Linked Issues

To Be Done

Create GitHub issues to track the work remaining, if any

  • #issue

Specific Security-related subjects a reviewer should pay specific attention to

  • Does this PR introduce new endpoints?
    • new endpoint A
    • new endpoint B
  • Does this PR include changes in authentication and/or authorization of existing endpoints?
  • Does this change introduce new dependencies that need vetting?
  • Does this change require changes to our infrastructure?
  • Does logging contain sensitive data?
  • Does this PR include or remove any sensitive information itself?

If you answered 'yes' to any of the questions above, conduct a detailed Review that addresses at least:

  • What are the potential security threats and mitigations? Please list the STRIDE threats and how they are mitigated
    • Spoofing (faking authenticity)
      • Threat T, which could be achieved by A, is mitigated by M
    • Tampering (influence or sabotage the integrity of information, data, or system)
    • Repudiation (the ability to dispute the origin or originator of an action)
    • Information disclosure (data made available to entities who should not have it)
    • Denial of service (make a resource unavailable)
    • Elevation of Privilege (reduce restrictions that apply or gain privileges one should not have)
  • Have you ensured logging does not contain sensitive data?
  • Have you received any additional approvals needed for this change?

Copy link

github-actions bot commented Dec 11, 2024

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

Copy link
Collaborator

@victor-chaparro victor-chaparro left a comment

Choose a reason for hiding this comment

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

Looks good, just had one minor change. We shouldn't reference master anymore. I think I may have sent you that link, so that's my bad.

prime-router/docs/onboarding-users/migrating-receivers.md Outdated Show resolved Hide resolved
@the-andrew
Copy link
Collaborator Author

Looks good, just had one minor change. We shouldn't reference master anymore. I think I may have sent you that link, so that's my bad.

Oh, I've been working off main, but my browser bookmark for the top level repo still goes to master. I can update the links.

Update based on review

Co-authored-by: victor-chaparro <117938212+victor-chaparro@users.noreply.github.com>
Copy link
Collaborator

@lucero-v lucero-v left a comment

Choose a reason for hiding this comment

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

Looks good! Thank you for testing those settings with me.

@the-andrew the-andrew merged commit 94f2337 into main Dec 17, 2024
20 checks passed
@the-andrew the-andrew deleted the docs/engagement/apham/16730-timezone-documentation branch December 17, 2024 21:50
Copy link

sonarcloud bot commented Dec 17, 2024

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.

Add timezone fix to documentation (fixed for CO, as reference)
4 participants