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 platform diagrams #705

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

Update the platform diagrams #705

fharper opened this issue May 21, 2024 · 0 comments
Assignees
Labels
P1 - Important Needed for our users to be able to properly use our product. wrong Some information in the documentation is wrong

Comments

@fharper
Copy link
Contributor

fharper commented May 21, 2024

What type of suggestions?

Something's not working

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:

  1. Get rid of the star-ish thing on arrows where there is a text next to them. It was a Kubeshop thing, but we want those diagrams to be simplified.
  2. Standardize how we use technology logo. As a first one, with or without names/text. Example, the GitHub logo is used with the text "GitHub", but not the GitLab one (see the first video below).
  3. Update the Argo Workflow logo: right now it's the Argo project logo in black to make an unclear distinction from Argo CD.
  4. Write full words as we have enough spaces for that, and it will make the diagram clearer. Example: "Management" instead of "Mgmt".
  5. Most logos are images and not SVGs: we need to replace them.
  6. Replace Vault logo for the latest (it's yellow now).
  7. Add Crossplane logo.
  8. Add vcluster logo.
  9. We may have an opportunity to merge the GitHub/GitLab diagrams in one as mentioned in the point Add a releases notes page with breaking changes #14 at Update the installation diagrams #704, but I'll let @johndietz confirmed or not this one.
  10. AWS logo is the old one, it needs to be updated.
  11. Order by ASC the cloud logos (maybe with k3d first like for our docs header menu).

First video

CleanShot.2024-04-04.at.17.06.05.mp4

@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 21, 2024
@fharper fharper changed the title Update the platform diagram Update the platform diagrams May 23, 2024
@fharper fharper added the P1 - Important Needed for our users to be able to properly use our product. label Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 - Important Needed for our users to be able to properly use our product. wrong Some information in the documentation is wrong
Projects
None yet
Development

No branches or pull requests

2 participants