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

adr: add flow bit rate property definitions ADR #86

Merged
merged 9 commits into from
Jan 3, 2025

Conversation

philipnbbc
Copy link
Contributor

Details

This PR adds draft ADR for discussion. It documents possible Flow bit rate property definitions and additional related properties.

Pivotal Story (if relevant)

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

Related PRs

Where appropriate. Indicate order to be merged.

Submitter PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • API version has been incremented if necessary
  • ADR status has been updated, and ADR implementation has been recorded
  • Documentation updated (README, etc.)
  • PR added to Pivotal story (if relevant)
  • Follow-up stories added to Pivotal

Reviewer PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • 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 PRs

The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.

@philipnbbc philipnbbc requested a review from a team as a code owner August 28, 2024 14:35
@philipnbbc philipnbbc force-pushed the philipn-bit-rate-properties branch from 1d958d9 to 3b58ca9 Compare August 28, 2024 14:39
@philipnbbc philipnbbc force-pushed the philipn-bit-rate-properties branch 3 times, most recently from e417d03 to 9c74c28 Compare November 13, 2024 12:01
@j616 j616 self-assigned this Jan 2, 2025
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.

A few nits and comments. Leaving review as a comment as changes alongside the ADR itself will likely need review for approval.

docs/README.md Show resolved Hide resolved
docs/adr/0022-flow-bit-rate-properties.md Outdated Show resolved Hide resolved
docs/adr/0022-flow-bit-rate-properties.md Outdated Show resolved Hide resolved
docs/adr/0022-flow-bit-rate-properties.md Outdated Show resolved Hide resolved
docs/adr/0022-flow-bit-rate-properties.md Outdated Show resolved Hide resolved
docs/adr/0022-flow-bit-rate-properties.md Show resolved Hide resolved
This change follows a discussion which decided that segment duration should
be added and a maximum 1.5 variance assumed.

It was decided that the maximum segment duration was not required.

The need to have segment size and maximum segment size requires further input.
@philipnbbc philipnbbc force-pushed the philipn-bit-rate-properties branch from 9c74c28 to de07161 Compare January 3, 2025 15:03
@philipnbbc philipnbbc requested a review from j616 January 3, 2025 15:17
@philipnbbc
Copy link
Contributor Author

A few nits and comments. Leaving review as a comment as changes alongside the ADR itself will likely need review for approval.

Changes have been made for further review. Note that I decided to not make the max_bit_rate property required.

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.

One more minor nit. Otherwise LGTM.

docs/appnotes/0013-setting-flow-bit-rate-properties.md Outdated Show resolved Hide resolved
@philipnbbc philipnbbc merged commit bb55d82 into main Jan 3, 2025
5 checks passed
@philipnbbc philipnbbc deleted the philipn-bit-rate-properties branch January 3, 2025 15:55
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