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.

Sign up for GitHub

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

Jump to bottom

docs: Split reference documentation into a self-standing guide #3188

Open
gdemonet opened this issue Mar 10, 2021 · 1 comment
Open

docs: Split reference documentation into a self-standing guide #3188

gdemonet opened this issue Mar 10, 2021 · 1 comment
Labels
complexity:medium Something that requires one or few days to fix kind:enhancement New feature or request topic:docs Documentation

Comments

@gdemonet
Copy link
Contributor

Component: docs

Why this is needed:

Today, reference information (such as TCP ports requirements, list of Prometheus recording rules, ...) is scattered across the Installation and Operation guides.

What should be done:

Extract these details into a Reference guide, and link to it from other guides when relevant.
@gdemonet gdemonet added kind:enhancement New feature or request topic:docs Documentation complexity:medium Something that requires one or few days to fix labels Mar 10, 2021
@gdemonet
Copy link
Contributor Author

Additional note (see https://github.com/scality/metalk8s/pull/3074/files#r583908179): verify that tables (since we'll have many of those in such a guide) are properly rendered for PDF output.

@gdemonet gdemonet mentioned this issue Mar 10, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
complexity:medium Something that requires one or few days to fix kind:enhancement New feature or request topic:docs Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gdemonet