search

kubefirst / docs

kubefirst documentation
https://docs.kubefirst.io
MIT License
5 stars 7 forks source link

Update the installation diagrams #704

Open fharper opened 1 month ago

fharper commented 1 month ago

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 installation diagram. Here are the results of our discussions on Slack including all points from @johndietz & myself:

  1. Update the Argo Workflow logo: right now it's the Argo project logo in black to make an unclear distinction from Argo CD.
  2. 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.
  3. Update the cloud logos for their colored versions (some are colored, some are just white).
  4. 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.
  5. Remove background on technology logos (some have none, some have black ones).
  6. Add the Metaphor logo when it's missing. If it's there, replace with the one including the text "Metaphor" since it's an unknown logo, and cannot be easily recognized.
  7. Add Crossplane logo.
  8. Add vcluster logo.
  9. Add kubefirst console or a better representation of cluster management (point from @johndietz, discussion will need to be done to clarify the need and design solution)
  10. Align the diagrams from the dark and light theme versions (see the first video below).
  11. 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 second video below). As a second one, use stacked or unstacked logos.
  12. Standardized color used for background (see the third video below).
  13. Make those diagram horizontal instead of vertical so it's easier to consume on a computer without having to scroll too much.
  14. Merge GitHub & GitLab diagram for all clouds (except k3d, or it will need more work to do the same as there are some noticeable differences) to use one image for both Git providers. We could represent GitHub/GitLab as a sliced box. It will be easier to maintain the diagrams, the docs, and better information display for the users.
  15. I didn't check them all, but I'm pretty sure most logos are images and not SVGs as it's the case of most diagrams created by Kubeshop.

First video:

https://github.com/kubefirst/docs/assets/1170989/9bfc2541-477a-4fde-8502-f8d813f75639

Second video:

https://github.com/kubefirst/docs/assets/1170989/a77218e0-c829-4088-8f08-232bc44c0652

Third video:

https://github.com/kubefirst/docs/assets/1170989/ba5fc6e1-13bd-41bf-b2ec-01cf223aad20

Code of Conduct