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

DOCS-1054: Add session management diagram to sessions page #1754

Conversation

sguequierre
Copy link
Collaborator

  • Worked on this concept w/ @JessamyT, hoping can help give users visual context on this page! Cristina drew up a beautiful diagram for us. Welcome to edits but will have to relay to cristina and might block for a bit if changing words/position

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 5, 2023
Copy link
Contributor

@andf-viam andf-viam left a comment

Choose a reason for hiding this comment

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

Hmm, I feel like we still need a sentence or two explaining how the metaphor of the diagram corresponds to the technology it represents. For my part, I'm still unclear on how the concept of a planetary orbit maps to off-client session management. A quick sentence making explicit the connection could bridge the gap!

Copy link
Collaborator

Choose a reason for hiding this comment

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

can it live somewhere else too? If not let's change that wording

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No it should be in orbit of the session management client in this analogy, has to be

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think you misunderstand me the image says "The user's sessions client can live here". That implies it can live somewhere else. It probably should be "The user's sessions client lives here"

Copy link
Collaborator

Choose a reason for hiding this comment

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

Unless that's wrong?

@sguequierre
Copy link
Collaborator Author

Hmm, I feel like we still need a sentence or two explaining how the metaphor of the diagram corresponds to the technology it represents. For my part, I'm still unclear on how the concept of a planetary orbit maps to off-client session management. A quick sentence making explicit the connection could bridge the gap!

Tried to address in sentence form, LMK what you think! Understand how this is confusing but I think it's helpful for some, if I can make it easy to understand

@npentrel
Copy link
Collaborator

npentrel commented Sep 8, 2023

Cool, looking good! just gotta now look at the image again. #1754 (comment)

@sguequierre
Copy link
Collaborator Author

Cool, looking good! just gotta now look at the image again. #1754 (comment)

Messaged Cristina, she will update my wording to be more direct! Will message you for re-review after that is updated

Copy link
Contributor

@andf-viam andf-viam left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for adding the explanation! Very helpful!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Do the heartbeats go both directions as indicated by the arrows? Or just one way?

@viambot
Copy link
Member

viambot commented Sep 11, 2023

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/cb8cf3295426716509a86c800b379e4e74702d00/public

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants