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

Update the GitOps Pipeline diagrams #708

Open
1 task done
fharper opened this issue May 23, 2024 · 0 comments
Open
1 task done

Update the GitOps Pipeline diagrams #708

fharper opened this issue May 23, 2024 · 0 comments
Assignees
Labels
P2 - Need It's needed, but not require for using our product. Great to have for a better user experience. wrong Some information in the documentation is wrong

Comments

@fharper
Copy link
Contributor

fharper commented May 23, 2024

What type of suggestions?

Wrong Information

What page is concerned?

No response

What version of the docs?

2.4+

What is the issue?

We have an opportunity to update the platform diagram. Here are the points I shared on Slack:

  • I think we should just mention in a simple way we use CWFT instead of listing them. I don't think it give any useful information to someone looking at the diagram as they would need to check the code to really understand what they do. It will also make the diagram simpler.
  • Most logos are images and not SVGs: we need to replace them.
  • Update the Argo Workflow logo: right now it's the Argo project logo in black to make an unclear distinction from Argo CD.
  • Get rid of the star-ish thing on arrows where they are text next to them. It was a Kubeshop thing, but we want those diagrams to be simplified.
  • Align the elements properly (ex.: at the bottom right, the Kubernetes logos are not centered)
  • Make a GitOps repository logo that represents it better than what we have right now with the mash-up of Argo CD + Terraform + Git. We could use this in all our diagrams.

@johndietz you didn't participate in this thread, so feel free to add or discuss your points here please.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@fharper fharper added the wrong Some information in the documentation is wrong label May 23, 2024
@fharper fharper added the P2 - Need It's needed, but not require for using our product. Great to have for a better user experience. label Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 - Need It's needed, but not require for using our product. Great to have for a better user experience. wrong Some information in the documentation is wrong
Projects
None yet
Development

No branches or pull requests

2 participants