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

Add health checks documentation #673

Merged
merged 11 commits into from
May 28, 2024
Merged

Add health checks documentation #673

merged 11 commits into from
May 28, 2024

Conversation

dhurley
Copy link
Collaborator

@dhurley dhurley commented May 15, 2024

Proposed changes

Add health checks documentation

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • I have run make install-tools and have attached any dependency changes to this pull request
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • If applicable, I have updated any relevant documentation (README.md)
  • If applicable, I have tested my cross-platform changes on Ubuntu 22, Redhat 8, SUSE 15 and FreeBSD 13

@dhurley dhurley self-assigned this May 15, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 15, 2024
Copy link

netlify bot commented May 15, 2024

Deploy Preview for agent-public-docs canceled.

Name Link
🔨 Latest commit 2262419
🔍 Latest deploy log https://app.netlify.com/sites/agent-public-docs/deploys/6655b1251f2c0500087d5053

Copy link
Contributor

@Jcahilltorre Jcahilltorre left a comment

Choose a reason for hiding this comment

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

approved with suggestions.

Have a look at the F5 NGINX documentation style guide (WIP) for the background to some of the suggestions.

@Jcahilltorre
Copy link
Contributor

@dhurley Is this doc for v2 or v3?

@dhurley
Copy link
Collaborator Author

dhurley commented May 15, 2024

@dhurley Is this doc for v2 or v3?

Its for v2

@dhurley dhurley marked this pull request as ready for review May 15, 2024 12:08
dhurley and others added 5 commits May 22, 2024 11:27
This commit changes the list of NGINX Agent variables to a table showing
how it maps to the CLI flags, with an exception for the variable that
doesn't have a flag yet. It links to the CLI flag section so that the
reader can view the descriptions for additional context.
* Add pending health status for Agent v2
@github-actions github-actions bot added chore Pull requests for routine tasks dependencies labels May 28, 2024
@oliveromahony oliveromahony merged commit 10193ba into main May 28, 2024
15 checks passed
@oliveromahony oliveromahony deleted the add-health-checks-doc branch May 28, 2024 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks dependencies documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants