-
Notifications
You must be signed in to change notification settings - Fork 358
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 header navigation with new 'Why Quarkus' tab #1763
base: main
Are you sure you want to change the base?
Conversation
9eb9a7f
to
f8326f4
Compare
I like the idea of a "Why Quarkus" section. The ecosystem should probably cross-link to "Browse Extensions" and also "Share extensions." Maybe a paragraph at the bottom, something like
|
@insectengine I think your feedback would be interesting here. Thanks! |
f8326f4
to
088946e
Compare
🎊 PR Preview 1df911d has been successfully built and deployed to https://quarkus-website-pr-1763-preview.surge.sh |
@gsmet - thanks for bringing this to my attention. @chrischiedo - Thank you for putting the effort into this. Reorganizing the primary navigation: Ecosystem page: Documentation vs Guides |
@insectengine - Thank you for your feedback! Reorganizing the primary navigation: Ecosystem page: Documentation vs Guides: Sidenote: I think the Micronaut folks have done a great job of separating the two aspects of "Documentation" vs "Guides". Note: I'll wait for your responses/feedback and then make the necessary changes to this PR. cc: @gsmet |
Thanks for the thoughtful response, @chrischiedo.
I think renaming the Ecosystem page to something less overloaded than 'Ecosystem' is a good start, but I'm still a bit concerned by the overlaps between it and our other ecosystem content. I think we should try and have a very good idea in our head of what problem we're trying to solve with this page. Is the aim to show users a hand-curated selection of integrations? This is definitely a useful aim - but I wonder whether quarkus.io/extensions isn't a better place for that. (We've had it on our todo list for ages to do some hand-curation and a 'featured' top bar, as well as a more automatic default sort by popularity.) The granularity of the items on ecosystem.html is bigger than a single extension in most cases, but maybe the default granularity on extensions.quarkus.io should also be larger than a single extension? (@gastaldi asked for this a while ago). As well as extensions, the ecosystem.page has some things that definitely shouldn't be on extensions.quarkus.io, like programming models and 'libraries we bake into the Quarkus platform'. So I guess that comes back to 'what problem are we trying to solve?' ... are we trying to give developers an idea of what kind of programming models they'll be using? or trying to reassure people that we're built on top of tried and tested libraries? or trying to give back thanks to the communities whose work we consume? |
Reorganizing the primary navigation: Here is a tracking board were we're outlining some future content pages: There are several proposed landing pages that would fit into the Why section as well. Ecosystem page: Documentation vs Guides: On @holly-cummins points, yes we need to do a better job of explaining to our users about the Quarkus ecosystem and how extensions play and important role. |
My initial reasoning around the use of the term "Ecosystem" was to convey the idea that Quarkus heavily builds upon existing, mature libraries/frameworks from the Java enterprise ecosystem. That learning/using Quarkus won't need you to learn a bunch of completely new stuff in order to be productive, but rather you'll leverage your existing knowledge from the Java enterprise space. And I think that matches with what you are describing as "...(existing?) programming models and libraries we bake into the Quarkus platform". Therefore if I were to rephrase this in terms of a "problem we are trying to solve", then I would go with: But based on the previous feedback from @insectengine, I can easily see why using the term "ecosystem" in this sense would be a bit restrictive. And as you've already alluded to, extensions would technically be considered as part of the ecosystem too. cc: @holly-cummins |
@chrischiedo - Thanks for bring up this topic. It's caused some good conversations about the prime navigation and some holes in our content. I'm going to work with @holly-cummins and put in a PR to change the name of the About prime navigation section to Why. I'm also going to put in a draft PR to cover adding your content from the proposed Ecosystem page to the What is Quarkus page. There needs to be some more conversation around the exact wording. Thank you so much for putting the effort into this! |
@chrischiedo thanks for the idea on putting "Why" on front page - just realized I hit merge without checking you were marked as coauthor. was not my intent. @insectengine if there is a PR with content from @chrischiedo let me know and I'll show how we can add him as co-contributor to that PR. |
@maxandersen - No problem at all. I'm really excited about the Quarkus project and I'm glad to contribute in any little way that I can. |
Short summary:
This PR updates the header navigation with a new "Why Quarkus" menu tab that contains five of the six items that were previously under the "About" tab.
Changes made:
Motivation:
I think that having the strengths/advantages of Quarkus listed under the About tab seems a bit odd (and less conspicuous). I think having them under the "Why Quarkus" tab clearly speaks to the reasons WHY one would/should choose Quarkus.
Motivation:
Instead of having only a single item under the "About" menu tab (having moved the rest to the "Why Quarkus" section), I think adding a section giving brief descriptions of some of the community projects that Quarkus leverages makes sense (and aligns with the theme of sharing something extra "about" the Quarkus framework).
Motivation:
While "guides" can technically be considered as a subset/type of documentation, I think documentation "proper" has a more broader sense. The existing content has a mix of tutorials, how-to guides, conceptual docs, and references. My point of view is that only the first two categories fit well under "guides", and perhaps we need to introduce another section for documentation (maybe quarkus.io/docs?). That would then host the conceptual docs, references, and a "user guide" (that covers things like: Dependency Injection in Quarkus, Testing in Quarkus, Data Access/ ORM in Quarkus, Security in Quarkus,etc.). We could even have Quarkus API documentation in there too. I'd be curious to know what other folks think about this suggestion/proposed change.
cc: @gsmet