Migrate access control example to documentation website #6572
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit migrates the access control example to the documentation website, converting the existing README into a page formatted for the production website. It also cleans up the frontmatter of the surrounding documents so that pages can be more easily re-arranged in the future. The converted page make use of single source embedded code blocks using files in the GitHub repository, as well as a highlighting feature of code blocks that has not been used in previous documentation.
✅ Deploy Preview will be available once build job completes!
|
for more information, see https://pre-commit.ci
…es-ingress into docs/example-migration
vepatel
reviewed
Oct 2, 2024
| @@ -1,96 +1,3 @@ | |||
| # Access Control | |||
| # Deploy an Access Control policy | |||
There was a problem hiding this comment.
Access Control is a feature and policy is one of the steps so the original title is apt
There was a problem hiding this comment.
The original title does not describe the intent of the document, and the new one is matched to the website document, which is written as an instruction.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6572 +/- ##
==========================================
- Coverage 53.08% 53.00% -0.08%
==========================================
Files 87 87
Lines 16200 16223 +23
==========================================
Hits 8599 8599
- Misses 7194 7217 +23
Partials 407 407 ☔ View full report in Codecov by Sentry. |
jputrino
reviewed
Oct 3, 2024
| IC_IP=<ip-address> | ||
| ``` | ||
|
|
||
| 2. The HTTP port of the same instance |
There was a problem hiding this comment.
Suggested change
| 2. The HTTP port of the same instance | |
| 2. The HTTP port of the same instance. |
jputrino
reviewed
Oct 3, 2024
|
|
||
| {{< ghcode "https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/refs/heads/main/examples/custom-resources/access-control/webapp.yaml" >}} | ||
|
|
||
| Apply it using *kubectl*: |
There was a problem hiding this comment.
Should 'kubectl' be formatted as code instead?
jputrino
reviewed
Oct 3, 2024
|
|
||
| ## Configure load balancing | ||
|
|
||
| Create a file named *virtual-server.yaml* for the VirtualServer resource. The *policies* field references the example application. |
There was a problem hiding this comment.
Suggested change
| Create a file named *virtual-server.yaml* for the VirtualServer resource. The *policies* field references the example application. | |
| Create a file named *virtual-server.yaml* for the VirtualServer resource. The *policies* field references the access control Policy created in the previous section. |
jputrino
reviewed
Oct 3, 2024
|
|
||
| --- | ||
|
|
||
| ## Deploy an Access Control policy |
There was a problem hiding this comment.
Suggested change
| ## Deploy an Access Control policy | |
| ## Deploy a Policy to deny access to your app |
jputrino
reviewed
Oct 3, 2024
|
|
||
| --- | ||
|
|
||
| ## Update the policy |
There was a problem hiding this comment.
Suggested change
| ## Update the policy | |
| ## Deploy a Policy to allow access to your app |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This pull request migrates the access control example to the documentation website, converting the existing README into a page formatted for the production website. It also cleans up the frontmatter of the surrounding documents so that pages can be more easily re-arranged in the future.
The converted page makes use of single source embedded code blocks using files in the GitHub repository, as well as a highlighting feature of code blocks that has not been used in previous documentation.
Checklist
Before creating a PR, run through this checklist and mark each as complete.