Update AppNote 0001 to include an example of retaining the original segment

Open Beginner friendly
#220 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
documentation

Research direction

Start by reading docs/appnotes/0001-multi-mono-essence-flows-sources.md and review its existing Flow and Source examples. Add an example and diagram for retaining the original single-segment mixed Flow alongside segmented mono-essence Flows and transcoded proxies, and explain that the segmented Flows can map essence from the concrete multi when only the container changes. Done means the AppNote clearly covers this upload scenario.

Written by the indexing model from the issue text.

Description

appnote

Context
AppNote 0001 describes a variety of structures of Flows and Sources for various purposes.

When discussing a tool for uploading camera cards, it came up that you might want to retain the original single-segment mixed Flow from the card, as well as segmented mono-essence Flows, and transcoded proxies.

Actions
We should provide an example and diagram for this case, and indicate that the segmented Flows can be the same ones that map essence from the concrete multi, providing only the container has changed.

Outcome
AppNote improvements

Note this is also tracked as https://jira.dev.bbc.co.uk/browse/CLOUDFIT-5587

Dominant language
Makefile
Stars
110
Forks
13
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bbc/tams

All issues in bbc/tams

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.