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

Juju ecosystem docs refresh #565

Merged
merged 28 commits into from
Feb 5, 2025
Merged

Juju ecosystem docs refresh #565

merged 28 commits into from
Feb 5, 2025

Conversation

abbiesims
Copy link
Contributor

@abbiesims abbiesims commented Jan 23, 2025

Done

  • Refreshes page according to this mock up
  • Adds global search across all RTD domains
  • Adds redirects for juju.is > RTD documentation

QA

  • Check the demo against the design
  • Search for documentation and make sure links are all RTD documentation
    • results will load 10 at a time with a "Load more" button rendering 10 more at a time
  • Test some /docs/juju/{doc_page} / /docs/sdk/{doc_page} pages and make sure they redirect to RTD

Issue / Card

Fixes WD-18284

@webteam-app
Copy link

@abbiesims abbiesims force-pushed the WD-18284/juju-ecosystem-docs branch from 805d345 to 2143670 Compare January 23, 2025 12:56
@jnsgruk
Copy link
Member

jnsgruk commented Jan 31, 2025

This looks like a great improvement, but looks like the alignment is a little odd in places? The "Juju Ecosystem" title feels oddly over to the right, to me?

Also the getting started section could maybe just be removed, with the button moving up to the "Install Juju" card or similar?

I hacked about in DevTools a bit and did this - hopefully makes sense?

image

@massigori
Copy link
Contributor

I agree with @jnsgruk about the left-alignment of the Juju ecossytem and Getting started with Juju sections, however I think we should keep the latter as a separate section since the downstream link points to a tutorial that takes the user across all the 4 steps

@lukasSerelis
Copy link

@jnsgruk @massigori should be still a separate section, we can right align it fully, however keeping it slightly indented makes it more focused on the page. My advice would be keeping it indented, as it highlights it without messing with the "happy path".

However it's not a make or break change so if you're super against the indentation @abbiesims can feel free to ditch it, but it would lose some priority. Just a quick side by side
image
image

@jnsgruk
Copy link
Member

jnsgruk commented Jan 31, 2025

How about moving the "Get started" CTA right to the top? Alignment is slightly off cos I was just hacking in DevTools, but hopefully gives an idea...

image

@lukasSerelis
Copy link

@jnsgruk your persistence won, we can't fit the "Get started with Juju" without breaking every Vanilla system law, but I can squeeze in the CTA and we call it a day?
image

@jnsgruk
Copy link
Member

jnsgruk commented Jan 31, 2025

Go for it

@abbiesims abbiesims force-pushed the WD-18284/juju-ecosystem-docs branch 2 times, most recently from 8a743b8 to aec79bf Compare February 3, 2025 12:09
Copy link

codecov bot commented Feb 3, 2025

Codecov Report

Attention: Patch coverage is 24.61538% with 49 lines in your changes missing coverage. Please review.

Project coverage is 49.00%. Comparing base (043a8fb) to head (aec79bf).
Report is 74 commits behind head on main.

Files with missing lines Patch % Lines
webapp/docs/search.py 19.23% 42 Missing ⚠️
webapp/app.py 46.15% 7 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #565      +/-   ##
==========================================
- Coverage   58.51%   49.00%   -9.51%     
==========================================
  Files           6        7       +1     
  Lines         188      251      +63     
==========================================
+ Hits          110      123      +13     
- Misses         78      128      +50     
Flag Coverage Δ
python 49.00% <24.61%> (-9.51%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@abbiesims abbiesims marked this pull request as ready for review February 3, 2025 12:14
@abbiesims abbiesims changed the title V1 juju ecosystem docs Juju ecosystem docs refresh Feb 3, 2025
Copy link
Contributor

@M7mdisk M7mdisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic work! 👏 🚀
just some minor comments and questions

@abbiesims abbiesims force-pushed the WD-18284/juju-ecosystem-docs branch from eccdfc3 to 4e5e1fb Compare February 3, 2025 14:34
Copy link
Contributor

@M7mdisk M7mdisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great!!!!
Amaaaaazing work 🚀 🚀 🚀 🚀 🚀

@M7mdisk M7mdisk mentioned this pull request Feb 5, 2025
@abbiesims abbiesims merged commit 9551e18 into main Feb 5, 2025
6 checks passed
@abbiesims abbiesims deleted the WD-18284/juju-ecosystem-docs branch February 5, 2025 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants