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

Improve docs site to have the same look and feel of the primary weave.works website #3910

Open
mestadler opened this issue Aug 3, 2023 · 7 comments
Assignees
Labels
team/timber-wolf type/enhancement New feature or request user-guide Improvements to docs at https://docs.gitops.weave.works/

Comments

@mestadler
Copy link

mestadler commented Aug 3, 2023

Problem

Currently, our docs and weave.works sites do not have the same look and feel. We want to have a seamless user experience, where the user starts on the main site and then can dive 'deeper' into our docs, without noticing.

Solution

Through css or other methods provided by Docusaurus the same look and feel of the company main website. Current css is located here, https://github.com/weaveworks/weave-gitops/blob/main/website/src/css/custom.css

Bonus would be to add link back to the weave.works main site in the nav bar, and so that customers can work back towards the main site if needed.

@mestadler mestadler added the type/enhancement New feature or request label Aug 3, 2023
@lasomethingsomething lasomethingsomething added the user-guide Improvements to docs at https://docs.gitops.weave.works/ label Aug 3, 2023
@alfaris
Copy link

alfaris commented Sep 4, 2023

Which docs page is our main
this
https://www.weave.works/docs/
or this
https://docs.gitops.weave.works/

and what's the difference

@mestadler
Copy link
Author

mestadler commented Sep 4, 2023 via email

@alfaris
Copy link

alfaris commented Sep 7, 2023

Hello,
@mestadler @MostafaMegahid @LappleApple

I've made our first iterations for enhancing and matching the docs with our website
you could see the 3 options on the screenshots below
basic
option 1
option 2

also you could see the full design on Figma through the following link
https://www.figma.com/file/IVHnM9iyeFWpd11evtY8ux/Weave-GitOps?type=design&node-id=19485-1454&mode=design&t=yKYxQZWSStaMTJfZ-4

Let me know your feedback

@lasomethingsomething
Copy link
Contributor

Overall looking good, thank you @alfaris. A few super-quick things:

  • I get that GitOps Run is a "main feature" in that it's available across WGE/OSS, but it's not a main draw of WeGO overall.
  • What's up with the wintry striped scarf? :)

@alfaris
Copy link

alfaris commented Sep 7, 2023

  • I used the same content on the landing page right now (https://docs.gitops.weave.works/) but we can improve it and change whatever will add value to the user browsing this page
  • The wintry striped scarf - I thought of something that will give personality to Weave as Example GitHub uses a character in the space or space items but also we can iterate on it to come up with better fictional representation

@mestadler
Copy link
Author

mestadler commented Sep 8, 2023 via email

@alfaris
Copy link

alfaris commented Sep 18, 2023

💡 Extra note for FE Engineers
the used font in Docs are "system-ui, -apple-system, "Segoe UI"
but in our website are "proxima-nova, sans-serif, "Helvetica Neue", Helvetica, Arial, sans-serif"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team/timber-wolf type/enhancement New feature or request user-guide Improvements to docs at https://docs.gitops.weave.works/
Projects
None yet
Development

No branches or pull requests

4 participants