Documentation #193
Documentation #193
Conversation
imane-ess
force-pushed
the
documentation
branch
from
2b6ae82
to
0aef447
Compare
Signed-off-by: imane-ess <[email protected]>
Signed-off-by: imane-ess <[email protected]>
Signed-off-by: imane-ess <[email protected]>
Signed-off-by: imane-ess <[email protected]>
imane-ess
force-pushed
the
documentation
branch
from
054072e
to
b961a3d
Compare
|
@imane-ess I approved your PR to run in CI as per our conversation on Slack, I noticed it's in draft mode, is there still more to do? If so, ping us when it's all ready for review. |
Thank you. I have marked the PR as ready for review. |
|
Hello @imane-ess! Would you please update your branch to grab the latest version of the docs and commit these changes against the latest? I'll continue reviewing once the update has been made. Thanks for your work! |
|
Hello again @imane-ess! After further review, could you please split this PR into two PR's: one that can be made against the Rancher Desktop docs repository that includes the glossary changes, and another made against the development documentation as a Rancher Desktop application PR which includes the diagrams. We want to split into two PR's as the diagrams could be beneficial to a development audience in understanding the application's design in more detail, and we currently have a user oriented design schema on the architecture page with overlap with your diagram. With having a developer audience in mind, could you please update the diagrams to contain a bit more detail for each layer (for example expanding on k3s/Traefik components, perhaps how the ingress controller is handled, how data volume is handled). Thanks again for your work and please don't hesitate to reach out with questions. |
These commits contain a few additions to the documentation that are intended to further clarify Rancher-Desktop's functioning to new users. A glossary is included, as well as diagrams of the functional architecture and networking layer.