-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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: link Core Components to Architecture #11342
Conversation
Signed-off-by: Rafael <117901458+RafaelClovr@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@agilgur5 Would you like to help review this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So documentation on the internals is typically placed in an "Architecture" page in most k8s projects. Argo has an "Architecture" page in the Developer Guide.
We could link to the Architecture page from here, and that page could certainly use more details, but I don't think the architectural details belong on this page, which is part of the User Guide.
A user does not need to know the underlying architecture to get started with Argo, but they certainly may want to. I think a link to the Architecture page would serve better for that purpose
@agilgur5 I agree, could be interesting to just add the link. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@RafaelClovr would you like to update your PR to add a link instead?
I provided a suggestion below as to what that may look like. The Architecture page itself could use a bit more details if you would like to improve that as well.
Will have to update the title of your PR to be more specific as well, for instance, docs: link Core Components to Architecture
. CI is also currently failing markdownlint
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Rafael <117901458+RafaelClovr@users.noreply.github.com>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Rafael <117901458+RafaelClovr@users.noreply.github.com>
Thanks for your contribution @RafaelClovr ! |
Motivation
The documentation does not talk about Workflows Server and Workflow controller
Modifications
I added few basic descriptions about that components.
Verification
Just take a look at the rest of the documentation.