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 docs with clarifications needed after review #424

Merged
merged 2 commits into from
Aug 16, 2024

Conversation

keithf4
Copy link
Collaborator

@keithf4 keithf4 commented Aug 15, 2024

Description

After further testing, update documentation with some clarifications that should make setup easier to follow.

Please indicate what kind of change your PR includes (multiple selections are acceptable):

  • Bugfix
  • Enhancement
  • Breaking Change
  • Documentation

PRs should be against existing issues, so please list each issue using a separate 'closes' line:

closes #

If this PR depends on another PR or resolution of another issue, please indicate that here using a separate 'depends' line for each dependency.

depends on #

If you have an external dependency (packages, portal updates, etc), add the 'BLOCKED' tag to your PR.

Testing

None of the testing listed below is optional.

  • Installation method:
    • Binary install from source, version:
    • OS package repository, distro, and version:
    • Local package server, version:
    • Custom-built package, version:
    • Other:
  • PostgreSQL, Specify version(s):
  • docs tested with hugo version(s):

Code testing

Have you tested your changes against:

  • RedHat/CentOS
  • Ubuntu
  • SLES
  • Not applicable

If your code touches postgres_exporter, have you:

  • Tested against all versions of PostgreSQL affected
  • Ensure that exporter runs with no scrape errors
  • Not applicable

If your code touches node_exporter, have you:

  • Ensure that exporter runs with no scrape errors
  • Not applicable

If your code touches Prometheus, have you:

  • Ensured all configuration changes pass promtool check config
  • Ensured all alert rule changes pass promtool check rules
  • Prometheus runs without issue
  • Alertmanager runs without issue
  • Not applicable

If your code touches Grafana, have you:

  • Ensured Grafana runs without issue
  • Ensured relevant dashboards load without issue
  • Not applicable

Checklist:

  • I have made corresponding changes to:
    • the documentation
    • the release notes
    • the upgrade doc

@keithf4 keithf4 self-assigned this Aug 15, 2024
@keithf4 keithf4 added the DOCS Documentation Issue label Aug 15, 2024
Copy link
Contributor

@jchancojr jchancojr left a comment

Choose a reason for hiding this comment

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

lgtm

@keithf4 keithf4 merged commit 0269241 into CrunchyData:v5_0-STABLE Aug 16, 2024
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOCS Documentation Issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants