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

[Website] Add stylized "Warning" callouts #185

Open
myronmarston opened this issue Feb 12, 2025 · 0 comments
Open

[Website] Add stylized "Warning" callouts #185

myronmarston opened this issue Feb 12, 2025 · 0 comments
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed website Issues related to the ElasticGraph website

Comments

@myronmarston
Copy link
Collaborator

Suggest an improvement

There are some warnings included in our docs but they aren't highlighted in any way to make them standout. We should improve that. Two examples:

{% comment %}TODO: figure out a way to highlight this section as a warning.{% endcomment %}
One thing to bear in mind: this query is selecting which _artists_ to return,
not which _albums_ to return. You might expect that the returned `nodes.albums` would
all be platinum-selling 90s albums, but that's not how the filtering API works. Only artists
that had a platinum-selling 90s album will be returned, and for each returned artists, all
their albums will be returned--even ones that sold poorly or were released outside the 1990s.

{% comment %}TODO: figure out a way to highlight this section as a warning.{% endcomment %}

URLs of impacted pages

https://block.github.io/elasticgraph/query-api/filtering/list/
https://block.github.io/elasticgraph/query-api/filtering/conjunctions/

Screenshots

Here's how those pages look now:

Image

Image

@myronmarston myronmarston added good first issue Good for newcomers help wanted Extra attention is needed website Issues related to the ElasticGraph website labels Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed website Issues related to the ElasticGraph website
Projects
None yet
Development

No branches or pull requests

2 participants