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

Change environment variable list to table with CLI references #689

Merged
merged 2 commits into from
May 27, 2024

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented May 27, 2024

Proposed changes

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.

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

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.
@ADubhlaoich ADubhlaoich self-assigned this May 27, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 27, 2024
Copy link

netlify bot commented May 27, 2024

Deploy Preview for agent-public-docs ready!

Name Link
🔨 Latest commit e870bc1
🔍 Latest deploy log https://app.netlify.com/sites/agent-public-docs/deploys/66546ee9d0520c000880c936
😎 Deploy Preview https://deploy-preview-689--agent-public-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ADubhlaoich ADubhlaoich merged commit 27a2a49 into main May 27, 2024
32 checks passed
@ADubhlaoich ADubhlaoich deleted the map-variables-flags branch May 27, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants