Skip to content

docs: quick start alerting section #1347

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
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: quick start alerting section #1347

wants to merge 1 commit into from

Conversation

makasim
Copy link
Contributor

@makasim makasim commented May 8, 2025 •
edited
Loading

@makasim makasim force-pushed the docs-quick-start-operator-alerting branch from 918efc3 to f739a29 Compare May 9, 2025 15:16
@makasim makasim marked this pull request as ready for review May 12, 2025 17:53
@makasim makasim force-pushed the docs-quick-start-operator-alerting branch from 99e0eac to 835a5bd Compare May 12, 2025 17:53
@makasim makasim requested review from hagen1778 and func25 May 12, 2025 17:56
@makasim makasim self-assigned this May 12, 2025
@makasim makasim added documentation Improvements or additions to documentation enhancement New feature or request labels May 12, 2025
@makasim makasim force-pushed the docs-quick-start-operator-alerting branch from 44b9a30 to fc6301c Compare May 13, 2025 06:50
hagen1778
hagen1778 previously approved these changes May 13, 2025
View reviewed changes
Copy link
Contributor

@hagen1778 hagen1778 left a comment

Choose a reason for hiding this comment

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

LGTM

@makasim makasim force-pushed the docs-quick-start-operator-alerting branch 2 times, most recently from cd78c00 to a71f298 Compare May 13, 2025 09:36
Haleygo
Haleygo previously approved these changes May 13, 2025
View reviewed changes
func25
func25 reviewed May 13, 2025
View reviewed changes
Copy link
Contributor

@func25 func25 left a comment

Choose a reason for hiding this comment

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

Idk what the convention is for the header. For example, under the ## Access (H2) heading, the document directly uses #### VMAuth and #### VMUser (H4 headings) for sub-sections. Same for ## Anything else.

image

@makasim
Copy link
Contributor Author

makasim commented May 13, 2025 •
edited
Loading

Idk what the convention is for the header. For example, under the ## Access (H2) heading, the document directly uses #### VMAuth and #### VMUser (H4 headings) for sub-sections. Same for ## Anything else.

@func25 I've not touched the Access section yet. I'll work on it in the next PR. The h6 headers serve the purpose of preserving links for BC, see #1354 (comment) and https://github.com/VictoriaMetrics/vmdocs/pull/149. Users won't see them in the menu.

Got it. I only changed the order of the Alerting and Access sections, but didn't modify the content of Access.

@makasim makasim force-pushed the docs-quick-start-operator-alerting branch from 6e8df7a to 6368e04 Compare May 13, 2025 14:38
@makasim makasim requested review from Haleygo, hagen1778 and func25 May 13, 2025 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@f41gh7 f41gh7 Awaiting requested review from f41gh7 f41gh7 is a code owner

@AndrewChubatiuk AndrewChubatiuk Awaiting requested review from AndrewChubatiuk AndrewChubatiuk is a code owner

@Haleygo Haleygo Awaiting requested review from Haleygo Haleygo is a code owner

@hagen1778 hagen1778 Awaiting requested review from hagen1778

@func25 func25 Awaiting requested review from func25

At least 1 approving review is required to merge this pull request.

Assignees

@makasim makasim

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@makasim @hagen1778 @func25 @Haleygo