Skip to content

Nginx plus dashboard additions #155

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

Merged
merged 3 commits into from
Feb 3, 2025

Conversation

bjee19
Copy link
Contributor

@bjee19 bjee19 commented Jan 30, 2025

Proposed changes

Problem: The Nginx Plus dashboard document needs to be updated with information on configuring access to it.

Solution: Add a section in dashboard.md giving a brief overview on how to change access to the dashboard with an example and a link to the data plane configuration document for more information. Additionally updated the api.md document to reflect the current state for NGF on main.

Testing: Checked the rendered documentation.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes, I have assessed the possible impact
  • 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
  • I have updated any relevant documentation (README.md and CHANGELOG.md)
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.

Please refer to our style guide for guidance about placeholder content.

@bjee19 bjee19 requested a review from a team as a code owner January 30, 2025 22:26
Copy link

github-actions bot commented Jan 30, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@bjee19
Copy link
Contributor Author

bjee19 commented Jan 30, 2025

For the api.md file, we decided to replace the recent changes made in #120 due to those changes not reflecting the current state of NGF on main. This api.md file is a direct copy of the one currently on main.

The changes made in #120 will be merged when we merge our feature branch to main in the NGF repo.

@bjee19
Copy link
Contributor Author

bjee19 commented Jan 30, 2025

I have hereby read the F5 CLA and agree to its terms

@sjberman
Copy link
Contributor

ngf team wasn't added as reviewers to this for some reason

Comment on lines 50 to 55
- type: IPAddress
value: 127.0.0.3
- type: IPAddress
value: 25.0.0.3
- type: CIDR
value: 27.0.0.1/32
Copy link
Contributor

Choose a reason for hiding this comment

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

Unless we're actually using these addresses, I think we're limited to the addresses in RFC 5737, "IPv4 Address Blocks Reserved for Documentation"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

cool, didn't know this was a thing, made the change

@mjang
Copy link
Contributor

mjang commented Feb 3, 2025

ngf team wasn't added as reviewers to this for some reason

Created #160

Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

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

Concerns addressed

@mjang mjang merged commit 905bb53 into nginx:ngf-release-2.0 Feb 3, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants