Skip to content

docs: Add page descriptions - #893

Open
lfrancke wants to merge 2 commits into
mainfrom
docs/page-descriptions
Open

lfrancke wants to merge 2 commits into
mainfrom
docs/page-descriptions

Conversation

@lfrancke

@lfrancke lfrancke commented Nov 5, 2026 •

Copy link
Copy Markdown
Member

Description

Part of stackabletech/issues#911

Part of the operator-wide rollout. Adds a :description: to every page.
I had Claude auto-generate the descriptions based on our previous PR in the documentation repo (stackabletech/documentation#895). This way search snippets and llms.txt have a summary to show.

Also includes the resource requests text from its new partial (stackabletech/documentation#976).

I did not include a changelog entry on purpose. I hope that's fine.

Note

I'll use this PR as the "template" PR and will bring up the remaining ones when this is accepted. The descriptions will be different but similar.

@lfrancke lfrancke self-assigned this Nov 5, 2026
@lfrancke lfrancke moved this to Development: Waiting for Review in Stackable Engineering Nov 5, 2026
:description: Find out about minimal HA Airflow requirements for CPU and memory, with defaults for schedulers, Celery executors, webservers, dagProcessors and triggerers using Kubernetes resource limits.

include::home:concepts:stackable_resource_requests.adoc[]
include::home:concepts:partial$stackable_resource_requests.adoc[]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This seems broken:

Unresolved include directive in modules/airflow/pages/usage-guide/storage-resources.adoc - include::home:concepts:partial$stackable_resource_requests.adoc[]

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Damn! Why did it work for me? Thanks. I'm on it.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Is this against the latest docs main branch with my other PR? stackabletech/documentation#976

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ah, that works

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

That's good but now I'm suspicious. Which command did you use to try it?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

make build-truly-local but the local documentation repo was not updated.
It worked after I updated the main branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: Waiting for Review

Development

Successfully merging this pull request may close these issues.

2 participants