Docs: graph edits to #25730#26160
Docs: graph edits to #25730#26160alexfornuto merged 2 commits intopaul.gottschling/2023-05-05-mermaidfrom
Conversation
There was a problem hiding this comment.
This pushes the label so it's not obstructed by the lines.
There was a problem hiding this comment.
Is there a more elegant way to achieve this? If not, I think we should add a comment above this line indicating why we have all of the non-breaking spaces.
There was a problem hiding this comment.
There is, but only for left-right diagrams. See mermaid-js/mermaid#1209 for discussion on this issue. I'll add the comment as suggested.
There was a problem hiding this comment.
At one point I had the idea to differentiate between Teleport Auth/Proxy and other Teleport services with colors. Happy to discuss if it's a good idea or not.
There was a problem hiding this comment.
Maybe it's just me/my monitor, but these colors look very similar to me! Should we just use one Teleport color?
Personally, I'm in favor of leaving all styling of our diagrams to an external stylesheet that we'll prepare later, but we can go with this approach in the meantime if you think it makes the graph clearer.
There was a problem hiding this comment.
Agreed that it can be one color. I'm also in favor of an external style sheet and can remove the colors once it's created... but FWIW leaving one or two examples like this may give @roraback and team something to go on while building said stylesheets.
There was a problem hiding this comment.
@ptgott I'm slightly concerned that this section of the graph describes a larger configuration than the page instructs.
There was a problem hiding this comment.
I thought it would make sense to show the Linux server within the context of a full Teleport deployment, since ultimately the intended user of the guide would be expanding their setup from the initial VM to protect more infrastructure resources.
I also thought it would look a bit odd to only show the Linux server box.
What do you think?
There was a problem hiding this comment.
I think that the easy solve here is to add a note under the diagram explaining that it shows a scenario that extends beyond the contents of this page, and that adding additional resources is covered by the "Next steps" section.
There was a problem hiding this comment.
I'm going to remove the diagram from the Linux Server guide so we can tackle that in a separate PR!
There was a problem hiding this comment.
Is there a more elegant way to achieve this? If not, I think we should add a comment above this line indicating why we have all of the non-breaking spaces.
There was a problem hiding this comment.
Maybe it's just me/my monitor, but these colors look very similar to me! Should we just use one Teleport color?
Personally, I'm in favor of leaving all styling of our diagrams to an external stylesheet that we'll prepare later, but we can go with this approach in the meantime if you think it makes the graph clearer.
There was a problem hiding this comment.
I thought it would make sense to show the Linux server within the context of a full Teleport deployment, since ultimately the intended user of the guide would be expanding their setup from the initial VM to protect more infrastructure resources.
I also thought it would look a bit odd to only show the Linux server box.
What do you think?
alexfornuto
force-pushed
the
afornuto/25730-suggest
branch
from
b1504b7 to
d1afac8
Compare
* Add mermaid diagram to key pages Add Mermaid diagrams to illustrate the architecture of a Teleport setup in two guides where the audience may be encountering this architecture for the first time: - Try out Teleport on a Linux Server - Deploying a High Availability Teleport Cluster * Fix spelling * Remove diagram from the Linux Server guide We will handle this change separately, with more attention, since this is a particularly high-traffic guide. * Docs: graph edits to #25730 (#26160) * graph edits * add comment, rm secondary color --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> Co-authored-by: Steven Martin <steven@goteleport.com>
* Add mermaid diagram to key pages Add Mermaid diagrams to illustrate the architecture of a Teleport setup in two guides where the audience may be encountering this architecture for the first time: - Try out Teleport on a Linux Server - Deploying a High Availability Teleport Cluster * Fix spelling * Remove diagram from the Linux Server guide We will handle this change separately, with more attention, since this is a particularly high-traffic guide. * Docs: graph edits to #25730 (#26160) * graph edits * add comment, rm secondary color --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
* Add mermaid diagram to key pages Add Mermaid diagrams to illustrate the architecture of a Teleport setup in two guides where the audience may be encountering this architecture for the first time: - Try out Teleport on a Linux Server - Deploying a High Availability Teleport Cluster * Fix spelling * Remove diagram from the Linux Server guide We will handle this change separately, with more attention, since this is a particularly high-traffic guide. * Docs: graph edits to #25730 (#26160) * graph edits * add comment, rm secondary color --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2 participants
Styling suggestions for mermaid graphs in #25730.