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

ENT-12142: Updated docs diagrams #3336

Merged
merged 4 commits into from
Sep 3, 2024
Merged

Conversation

chiachenglu
Copy link
Contributor

@chiachenglu chiachenglu commented Sep 3, 2024

Updated the diagrams

Ticket: ENT-12142

@chiachenglu chiachenglu added the WIP work in progress label Sep 3, 2024
@chiachenglu chiachenglu changed the title Updated diagrams ENT-12142: Updated docs diagrams Sep 3, 2024
@chiachenglu chiachenglu removed the WIP work in progress label Sep 3, 2024
@olehermanse
Copy link
Member

@cf-bottom please build this in Jenkins :)

@olehermanse olehermanse merged commit 39d0a25 into cfengine:master Sep 3, 2024
2 checks passed
Copy link
Member

Choose a reason for hiding this comment

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

Here it shows commuting policy files and defining state directly on the hub, generally I would show that as a separate repository that the hub itself interfaces with but that might not be important in this specific image.

Copy link
Member

Choose a reason for hiding this comment

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

Yea, that's not the point of this diagram, it's to relate the 3 steps (define desired state, ensure / enforce state, verify actual state) with the other diagram. The user could be editing "directly" i.e. using ssh / cf-remote, or it could be going via another git server.

The arrow doesn't really mean "directly". In general, there's always more complexity, and we have to choose what to show (there's the whole TCP / IP stack, routers and switches, TLS connections, firewalls, voltages and electrons, and photons and electromagnetic radiation in the case of WiFi and fiberoptics).

I think it's good as is.

Copy link
Member

Choose a reason for hiding this comment

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

Show the cosmic rays

Copy link
Member

@nickanderson nickanderson left a comment

Choose a reason for hiding this comment

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

These are good improvements.

@nickanderson
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants