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: link Core Components to Architecture #11342

Merged
merged 3 commits into from
Jul 14, 2023

Conversation

RafaelClovr
Copy link
Contributor

@RafaelClovr RafaelClovr commented Jul 12, 2023

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.

Signed-off-by: Rafael <117901458+RafaelClovr@users.noreply.github.com>
@RafaelClovr RafaelClovr changed the title Improved Core Components documentation docs: Improved Core Components documentation Jul 12, 2023
Copy link
Member

@terrytangyuan terrytangyuan left a 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?

Copy link
Member

@agilgur5 agilgur5 left a 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

@RafaelClovr
Copy link
Contributor Author

@agilgur5 I agree, could be interesting to just add the link.

Copy link
Member

@agilgur5 agilgur5 left a 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

docs/workflow-concepts.md Outdated Show resolved Hide resolved
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Rafael <117901458+RafaelClovr@users.noreply.github.com>
@RafaelClovr RafaelClovr changed the title docs: Improved Core Components documentation docs: link Core Components to Architecture Jul 13, 2023
docs/workflow-concepts.md Outdated Show resolved Hide resolved
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Rafael <117901458+RafaelClovr@users.noreply.github.com>
@terrytangyuan terrytangyuan enabled auto-merge (squash) July 14, 2023 13:56
@terrytangyuan terrytangyuan merged commit 7883bf4 into argoproj:master Jul 14, 2023
23 checks passed
@agilgur5
Copy link
Member

Thanks for your contribution @RafaelClovr !
If you'd like to contribute more details to the Architecture page or any other docs, feel free to make additional PRs 🙂

@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants