Skip to content

[docs] Refine "Section applicability differs from page applicability" #1745

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

colleenmcginnis
Copy link
Contributor

Closes https://github.com/elastic/docs-content-internal/issues/218

Refine Section applicability differs from page applicability based on review comments in #1614, specifically:

  • Discussing if there's should be a difference between how we tag pages with varying content related to deployment types and pages about serverless vs. stateful. Also, how to frame the differences to make it as easy as possible for docs contributors to understand. (comment)
  • Reframe how this impacts the reader experience. (comment)
  • Whether to double down on the positive applies_to badges on serverless vs. stateful pages. (comment)

@colleenmcginnis
Copy link
Contributor Author

@elastic/docs-engineering why is it asking me to create redirects for images?

Screenshot 2025-08-14 at 5 38 39 PM

Copy link

github-actions bot commented Aug 14, 2025

@colleenmcginnis colleenmcginnis marked this pull request as ready for review August 15, 2025 13:44
@colleenmcginnis colleenmcginnis requested review from a team as code owners August 15, 2025 13:44
Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think your explanation is really clear. I still think this is a tricky concept but this captures our reasoning.

possible enhancement: swap the serverless/stateful + deployment methods sections. there is more of the serverless/stateful problem in our docs and it's probably good to front-load it.

Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

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

Successfully merging this pull request may close these issues.

3 participants