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

Make timerange more prominent in docs #9

Merged
merged 1 commit into from
Dec 20, 2023

Conversation

samdbmg
Copy link
Member

@samdbmg samdbmg commented Dec 19, 2023

Details

Moves the definition of TimeRange and Timestamp into a JSON schema file, and references it in all the types that use it.
Also adds links from the descriptions in rendered docs.

Pivotal Story

Story URL: https://www.pivotaltracker.com/story/show/186709535

Related PRs

Follows #8

Links to external test runs/working deployment

N/A

Submitter PR Checks

(tick as appropriate)

  • Added bbc/rd-apmm-cloudfit team as a reviewer
  • PR completes task/fixes bug
  • Tests exercise code appropriately
  • New features and API breaks are flagged in commit messages using magic strings
  • Repo maintainer is notified that a release is required
  • Documentation updated (README, Confluence, Docstrings, API spec, Engineering Guide, etc.)
  • Downstream repos have been checked for potential breaks & fixed as needed
  • APIs/UIs/CLIs updated as required
  • PR added to Pivotal story
  • Follow-up stories added to Pivotal
  • Any temporary code/configuration removed (e.g. test deployment environment, temporary commontooling branch)
  • Any pins against pre-releases have been removed

Reviewer PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • Tests exercise code appropriately
  • Design makes sense, and fits with our current code base
  • Code is easy to follow
  • PR size is sensible
  • Commit history is sensible and tidy

Info on Cloudfit PRs

@samdbmg samdbmg requested a review from a team December 19, 2023 13:30
@samdbmg samdbmg force-pushed the sammg-make-timerange-more-prominent branch from 83f06bd to af7fb56 Compare December 19, 2023 14:03
@samdbmg samdbmg marked this pull request as ready for review December 19, 2023 14:04
@j616 j616 self-assigned this Dec 20, 2023
Copy link
Contributor

@j616 j616 left a comment

Choose a reason for hiding this comment

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

LGTM

@samdbmg samdbmg force-pushed the sammg-use-stoplight-elements branch from b784064 to 68f7980 Compare December 20, 2023 17:00
Base automatically changed from sammg-use-stoplight-elements to main December 20, 2023 17:01
Makes the definition of a TimeRange more prominent by referencing it in
all the schemas that use it.
Also adds links from the descriptions in rendered docs.
@samdbmg samdbmg force-pushed the sammg-make-timerange-more-prominent branch from af7fb56 to f0fdffd Compare December 20, 2023 17:04
@samdbmg samdbmg merged commit b5dcb19 into main Dec 20, 2023
3 checks passed
@samdbmg samdbmg deleted the sammg-make-timerange-more-prominent branch December 20, 2023 17:05
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.

2 participants