Skip to content

Docs: High level data plane configuration overview #2246

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

Closed
sjberman opened this issue Jul 15, 2024 · 0 comments · Fixed by #2378
Closed

Docs: High level data plane configuration overview #2246

sjberman opened this issue Jul 15, 2024 · 0 comments · Fixed by #2378
Assignees
Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/small Estimated to be completed within ~2 days
Milestone

Comments

@sjberman
Copy link
Collaborator

sjberman commented Jul 15, 2024

As an NGF user,
I want to know what type of data plane fields I can configure,
So that I know how to change the settings of my data plane to fit my use case.

Acceptance

  • A guide is created to give an overview of the NginxProxy CRD
  • References to the API reference for NginxProxy, custom policy guide, and tracing policy guide are included in the data plane configuration guide.

Similar to how we have a control plane configuration page, it may be wise to include a high-level data plane configuration page. This doc could give a brief overview of things a user can configure, specifically using the NginxProxy resource, and then provide links to relevant docs that dive deeper, like the API reference, or tracing guide, or custom policies guide.

Chances are users will visit the Configuration section of our docs, looking for data plane information and not find it.

@sjberman sjberman added the documentation Improvements or additions to documentation label Jul 15, 2024
@mpstefan mpstefan added refined Requirements are refined and the issue is ready to be implemented. size/small Estimated to be completed within ~2 days labels Jul 24, 2024
@mpstefan mpstefan added this to the v1.4.0 milestone Jul 24, 2024
@sjberman sjberman self-assigned this Aug 12, 2024
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 refined Requirements are refined and the issue is ready to be implemented. size/small Estimated to be completed within ~2 days
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants