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

Don't use flat lists of links in container topics #7661

Open
lauracowen opened this issue Oct 31, 2024 · 3 comments
Open

Don't use flat lists of links in container topics #7661

lauracowen opened this issue Oct 31, 2024 · 3 comments
Assignees
Milestone

Comments

@lauracowen
Copy link
Member

lauracowen commented Oct 31, 2024

image

This isn't helpful because it implies all are equal (less an issue in this particular container topic but more a problem in, say, the Observability container topic and not a style we should be adopting). It also leads with the topic then gives some info about why you might want to know about it, assuming that the reader will read each in turn. Just give the link to more info after explaining why the technology is a useful alternative in the context of what's been said above it.

@dmuelle dmuelle added this to the 24.0.0.12 milestone Oct 31, 2024
@dmuelle dmuelle self-assigned this Oct 31, 2024
@dmuelle dmuelle modified the milestones: 24.0.0.12, 25.0.0.1 Nov 27, 2024
dmuelle added a commit that referenced this issue Jan 7, 2025
dmuelle added a commit that referenced this issue Jan 14, 2025
@dmuelle
Copy link
Member

dmuelle commented Jan 14, 2025

Hi Laura- Ive rewritten this topic to make it less like a KC-style container topic:

https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/rest-alternatives.html

Initially, I rewrote it to have the three alternatives in a single paragraph with inline links. But I think since there are three specific frameworks that are summarized relevant to OL, the bulleted list improves readability and is also more succinct. I understand this isnt that different than what I had before but it is also no longer just a flat list of topic links. The only other container topic we have that uses this pattern is the Observability parent topic, which Im going to rework per #7659.

@lauracowen
Copy link
Member Author

I think that's much clearer.

At risk of being a pain, I wonder if it's a bit too negative about REST? Also, I wondered if the GraphQL one could be framed more in terms of what it can do rather than just what problem it resolves (eg "returns just the data required, which addresses the under-/over-fetching problem" - badly worded I know).

dmuelle added a commit that referenced this issue Jan 17, 2025
@dmuelle
Copy link
Member

dmuelle commented Jan 17, 2025

I guess we dont want to throw REST under the bus :)

I added a clear value prop for REST, and also for graphQL in the updated draft: https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/rest-alternatives.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants