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

Enhance Dev UI Visibility with Dedicated Page and Homepage Section #2174

Open
josephaw1022 opened this issue Nov 26, 2024 · 4 comments · May be fixed by #2178
Open

Enhance Dev UI Visibility with Dedicated Page and Homepage Section #2174

josephaw1022 opened this issue Nov 26, 2024 · 4 comments · May be fixed by #2178

Comments

@josephaw1022
Copy link
Contributor

josephaw1022 commented Nov 26, 2024

Description

The current link to the Dev UI on the Developer Joy page directs users to the Dev UI guide. However, this guide explicitly states:

This guide covers the Quarkus Dev UI for extension authors.

While the guide is helpful for extension authors, it dives into technical details that may not be relevant or appealing to developers who are new to Quarkus and simply want to explore the Dev UI's functionality. A more accessible, visually appealing page would help showcase the dev ui's capabilities in a way that is easier to understand for a broader audience.

Note: This new page is not meant to replace the current Dev UI guide. Instead, it is intended to complement it. While the new page will focus on showcasing the purpose and features of the Dev UI, the existing guide would continue to explain how to utilize the dev ui for extension authorship.

Proposal:

  1. Dedicated Dev UI Page
    Create a new page specifically designed to showcase the Dev UI's functionality. This page would focus on what the dev ui offers to developers, emphasizing features over technical setup or extension authoring. Key features to highlight could include:

    • Modifying configuration
    • Viewing Swagger API documentation
    • Building Helm charts
    • Building container images
    • Visualizing dependencies
    • Running integration tests
    • Viewing the README
    • Viewing database entities and SQL scripts for create, update, and drop operations
    • Keycloak integration
    • UI for Kafka
  2. Streamlined and Visual Content
    Instead of focusing on backend or extension author-specific details, this page would showcase the Dev UI's functionality with screenshots, GIFs, and simple descriptions. This approach would make the content more engaging and easier for new users to grasp.

  3. Homepage Integration
    Add a section to the homepage highlighting the Dev UI as a core feature of Quarkus. This section could provide a brief summary and link to the newly created dedicated page.

Obviously this isn't the final product would actually fit the design, but wrote a quick snippet to get the idea across for what I mean for the homepage section. If implemented, it would obviously follow the design patterns set in the project already, but this is just to illustrate what I am getting at.
Image

Benefits:

  • Improved Accessibility: A dedicated page for the Dev UI makes its functionality more accessible to developers who are not extension authors.
  • Engaging Design: Visual content and an intuitive layout can better capture attention and communicate the value of the ui.
  • Complementary Documentation: The new page will help developers understand what the ui can do, while the current guide continues to serve extension authors.
@phillip-kruger
Copy link
Member

Sounds like a good idea. Are you preparing a PR ?

@josephaw1022
Copy link
Contributor Author

Not opposed to attempting to make one @phillip-kruger

@phillip-kruger
Copy link
Member

OK great ! Waiting for your PR.

@josephaw1022 josephaw1022 linked a pull request Nov 27, 2024 that will close this issue
@josephaw1022
Copy link
Contributor Author

@phillip-kruger pr is made. To be clear, it's not done. But it's a good starting point for now. #2178

@josephaw1022 josephaw1022 changed the title Enhance Dev Dashboard Visibility with Dedicated Page and Homepage Section Enhance Dev UI Visibility with Dedicated Page and Homepage Section Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants