quarkus icon indicating copy to clipboard operation
quarkus copied to clipboard

Show the list of endpoints on the default index page

Open ia3andy opened this issue 1 year ago • 11 comments

Describe the bug

Currently it's not obvious how to find the list of available endpoints when opening Quarkus: image

This is very important as we previously had the codestart list with their link and now there is nothing to find it.

Expected behavior

Display the list of endpoint like on the 404 page image

Actual behavior

No response

How to Reproduce?

Create any Quarkus app with a codestart from code.quarkus.io

Output of uname -a or ver

No response

Output of java -version

No response

Quarkus version or git rev

3.14.0

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

No response

ia3andy avatar Aug 28 '24 07:08 ia3andy

/cc @cescoffier (devui), @phillip-kruger (devui,mvnpm)

quarkus-bot[bot] avatar Aug 28 '24 07:08 quarkus-bot[bot]

couldn't the page include the readme sections that each codestart contribute to readme ?

they can have more info than just URLs to go visit.

maxandersen avatar Aug 28 '24 08:08 maxandersen

Also I think we should sort the list of endpoint by number of / in order to have the direct pages first..

ia3andy avatar Aug 28 '24 08:08 ia3andy

Could we please not marked as [important] something that's not even a bug?

I agree we can improve but it's really not that important compared to a lot of other things we have in this tracker and I don't think it's worth driving the attention of everyone having a look at issues.

Thanks.

gsmet avatar Aug 28 '24 12:08 gsmet

I think it's a very severe bug as it means all users starting with Quarkus won't have the right link in their starter app. I wouldn't put [important] if it wasn't..

ia3andy avatar Aug 28 '24 12:08 ia3andy

I also added important because it look like a minor issue, but it really isn't

ia3andy avatar Aug 28 '24 12:08 ia3andy

It's a bug. Code starts in past could add info to guide users to what to navigate to and what to do.

Relevant for the quick presets added to code.quarkus which now don't show/help the user what to do.

maxandersen avatar Aug 28 '24 13:08 maxandersen

The title of an issue should not indicate its priority or importance. Doing so would break tools' building release notes or script reporting activity (typically, I would do the same edit because it messes up my report). We have "priority" labels (blocker and urgent). We could potentially add "important."

However, I'm not totally sure about the "good first issue".

cescoffier avatar Aug 28 '24 13:08 cescoffier

BTW, I totally agree it's a bug / regression and we should fix it, and backport it to the LTS.

cescoffier avatar Aug 28 '24 13:08 cescoffier

The title of an issue should not indicate its priority or importance. Doing so would break tools' building release notes or script reporting activity (typically, I would do the same edit because it messes up my report). We have "priority" labels (blocker and urgent). We could potentially add "important."

However, I'm not totally sure about the "good first issue".

I should have asked the proper way to mark it as important you are right..

The fix shouldn't be too hard as we already have the 404 page no?

ia3andy avatar Aug 28 '24 13:08 ia3andy

It should not be too hard if you are @phillip-kruger .... it can be a bit overwhelming if that's your first contribution.

cescoffier avatar Aug 28 '24 13:08 cescoffier

I'll have a look

phillip-kruger avatar Aug 28 '24 21:08 phillip-kruger

lets add link to the readme on local file system from the index page - then I think we are covered well for LTS to enable codestarts to provide context/info to users.

maxandersen avatar Sep 04 '24 09:09 maxandersen

and the list of endpoints please :)

ia3andy avatar Sep 04 '24 09:09 ia3andy

This is done

phillip-kruger avatar Sep 24 '24 01:09 phillip-kruger