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

docs: Update cluster sizing page for distributed/microservices mode #15820

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

poyzannur
Copy link
Contributor

What this PR does / why we need it:

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jan 17, 2025
@poyzannur poyzannur changed the title add new tables Update cluster sizing page for distributed/microservices mode Jan 17, 2025
@poyzannur poyzannur changed the title Update cluster sizing page for distributed/microservices mode docs: Update cluster sizing page for distributed/microservices mode Jan 17, 2025
Copy link
Contributor

github-actions bot commented Jan 17, 2025

@poyzannur poyzannur force-pushed the poyzan/update-sizing-calculator branch from 712d934 to fd55781 Compare January 17, 2025 16:42
@poyzannur poyzannur force-pushed the poyzan/update-sizing-calculator branch from fd55781 to 2032ba6 Compare January 17, 2025 21:03
@JStickler
Copy link
Contributor

Looking at the preview for this, we probably want to add some instructions so that people know what to do with the information presented here.
I would add a line before the "Node Type?" that says something like, "Select your node type from the following menu." and then before the table add an explanation of what's being displayed in the table, and also make it clear that there are three tabs, because the UI indicator is rather subtle.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/L type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants