Skip to content

feat(docs): add sizing guide#264

Open
sed-i wants to merge 14 commits intomainfrom
feature/sizing
Open

feat(docs): add sizing guide#264
sed-i wants to merge 14 commits intomainfrom
feature/sizing

Conversation

@sed-i
Copy link
Copy Markdown
Contributor

@sed-i sed-i commented Apr 16, 2026

In this PR:

  • Include relevant information from the discourse post.
  • Consolidate information in fewer docs.

@sed-i sed-i requested review from YanisaHS and Copilot April 17, 2026 04:27
@sed-i sed-i marked this pull request as ready for review April 17, 2026 04:27
@sed-i sed-i requested a review from a team as a code owner April 17, 2026 04:27
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a consolidated “Sizing guide” reference page and updates existing docs to point readers to it, replacing scattered sizing/storage guidance previously linked from a Discourse post.

Changes:

  • Update COS/COS Lite tutorials and reference pages to link to the new sizing guide for production sizing guidance.
  • Expand system-requirements.md into a sizing guide with workload tables, combined-workload formulas, and storage-retention estimation.
  • Consolidate storage sizing guidance into reference docs (notably storage.md) and reorganize the Reference index navigation.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
docs/tutorial/cos-lite-microk8s-sandbox.md Adds a link from tutorial prerequisites to the sizing guide for production guidance.
docs/tutorial/cos-lite-canonical-k8s-sandbox.md Adds a sizing-guide pointer in prerequisites.
docs/tutorial/cos-canonical-k8s-sandbox.md Adds a sizing-guide pointer in prerequisites.
docs/reference/topology.md Adds a sizing-guide link from COS Lite topology description.
docs/reference/system-requirements.md Renames/reframes as “Sizing guide” and adds workload sizing + formulas + storage estimation.
docs/reference/storage.md Replaces Discourse sizing reference with sizing-guide link and adds storage recommendation tables.
docs/reference/index.md Adds a “Sizing & capacity” section and moves sizing/storage entries into it.
docs/how-to/configure-and-tune/evaluate-telemetry-volume.md Updates resource-requirements link target to the sizing guide.
docs/explanation/architecture/stack-variants.md Adds a link from the comparison table to the sizing guide.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/reference/storage.md Outdated
Comment thread docs/reference/storage.md Outdated
Comment thread docs/reference/storage.md Outdated
Comment thread docs/explanation/architecture/stack-variants.md Outdated
Comment thread docs/tutorial/cos-canonical-k8s-sandbox.md Outdated
Comment thread docs/reference/storage.md
Comment thread docs/reference/storage.md Outdated
Comment thread docs/reference/storage.md
Your Name and others added 7 commits April 17, 2026 00:36
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Leon <82407168+sed-i@users.noreply.github.com>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This doc is being removed in #262 . If this information is still needed - can you put it somewhere else?

Comment thread docs/reference/storage.md
---

# Storage Best Practices
# Storage best practices
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Add a line between the H1 and H2 with context, like "Use this document to plan storage for a COS or COS Lite deployment."

Comment thread docs/reference/storage.md

## General-purpose storage recommendations

The following estimates are based on past experience for medium-sized COS stacks.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

If you can provide any more detail here, that would be helpful. It's not clear what a "medium-sized" stack is to me.

If you don't have more details to provide (i.e., these are just observational estimations), then leave as is

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The formatting for this one is off from the rest of the docs - you should remove the line limits

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

Successfully merging this pull request may close these issues.

3 participants