Skip to content

Docs:/streams: try to explain streams lifecycle #1736

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

Closed
wants to merge 2 commits into from

Conversation

jbtrystram
Copy link
Member

I have been struggling a bit to understand how the content is promoted between the streams, so I tried to improve the documentation a little.

I thought of adding a mermaid chart as well but I am not sure if it's really helpful.

Also, delete bodhi-updates references, see #1734

I have been struggling a bit to understand how the content is promoted
between the streams, so I tried to improve the documentation a little.

I thought of adding a mermaid chart as well but I am not sure if it's
really helpful.

Also, delete bodhi-updates references, see coreos#1734
@jlebon
Copy link
Member

jlebon commented May 22, 2024

There are multiple things here in both the old and new texts that aren't quite right/outdated. Some things in the new text also duplicate other sections. WDYT about instead focusing this PR on scrubbing out bodhi-updates and bodhi-updates-testing for now and I can do a follow-up that updates this doc more generally to reflect reality?

@jbtrystram
Copy link
Member Author

jbtrystram commented May 22, 2024

WDYT about instead focusing this PR on scrubbing out bodhi-updates and bodhi-updates-testing for now

You are right let's split that out: #1738

@jbtrystram
Copy link
Member Author

jbtrystram commented May 22, 2024

@jlebon BTW, what do you think about merging Design.md and stream-tooling.md as they are redundant in some areas ?

There are multiple things here in both the old and new texts that aren't quite right/outdated. Some things in the new > text also duplicate other sections. ... I can do a follow-up that updates this doc more generally to reflect reality?

If you don't mind I'd like to do the follow-up on the doc update. I know it's going to be a slower process, but IMHO the process of figuring this out is valuable :)

@jlebon
Copy link
Member

jlebon commented May 22, 2024

@jlebon BTW, what do you think about merging Design.md and stream-tooling.md as they are redundant in some areas ?

The difference is that the text in Design.md is more about the high-level design, while stream-tooling.md is more about implementation details of how to achieve it. It seems like a useful distinction to maintain for people who want to get acquainted with the model without caring about implementation?

I do think though that stream-tooling.md should probably link to that section of Design.md as a "required reading".

If you don't mind I'd like to do the follow-up on the doc update. I know it's going to be a slower process, but IMHO the process of figuring this out is valuable :)

Works for me!

Copy link
Member

@travier travier left a comment

Choose a reason for hiding this comment

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

Mostly LGTM. Some nits

@travier
Copy link
Member

travier commented Jul 10, 2024

Ah, looks like Jonathan founds things I missed: #1736 (comment)

Co-authored-by: Timothée Ravier <[email protected]>
@c4rt0
Copy link
Member

c4rt0 commented Mar 31, 2025

Closing on behalf of: #1912

@c4rt0 c4rt0 closed this Mar 31, 2025
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.

4 participants