docs: Reorganise examples #2871
Merged
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
github-actions
bot
added
the
documentation
lucacome
reviewed
Jul 21, 2022
Codecov Report
@@ Coverage Diff @@
## main #2871 +/- ##
==========================================
- Coverage 52.32% 52.30% -0.03%
==========================================
Files 58 58
Lines 15959 15959
==========================================
- Hits 8351 8347 -4
- Misses 7330 7332 +2
- Partials 278 280 +2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
ciarams87
force-pushed
the
move-examples
branch
from
3847171
to
d7bc7c5
Compare
lucacome
reviewed
Aug 23, 2022
| @@ -1,33 +1,31 @@ | |||
| --- | |||
| title: Configuration | |||
|
|
|||
| description: "This document describes how to configure the NGINX App Protect module." | |||
| description: "This document describes how to configure the NGINX App Protect WAF module." | |||
There was a problem hiding this comment.
Should the folder here also be app-protect-waf instead of just app-protect? Also the folder in ingress-resources?
I've also noticed that in the docs is app-protect but in the examples is appprotect.
jputrino
reviewed
Aug 23, 2022
jputrino
reviewed
Aug 23, 2022
jputrino
reviewed
Aug 23, 2022
jputrino
reviewed
Aug 23, 2022
docs/content/troubleshooting/troubleshooting-with-app-protect.md
Outdated
Show resolved
Hide resolved
jputrino
reviewed
Aug 23, 2022
docs/content/troubleshooting/troubleshooting-with-app-protect.md
Outdated
Show resolved
Hide resolved
jputrino
approved these changes
Aug 23, 2022
Co-authored-by: Jodie Putrino <j.putrino@f5.com>
ciarams87
force-pushed
the
move-examples
branch
3 times, most recently
from
7c1e995
to
724fc69
Compare
ciarams87
force-pushed
the
move-examples
branch
from
724fc69
to
0b6a1bf
Compare
haywoodsh
approved these changes
Aug 24, 2022
haywoodsh
reviewed
Aug 24, 2022
haywoodsh
pushed a commit
that referenced
this pull request
Aug 30, 2022
* Initial attempt at reorganising examples * Rename waf and dos folders * Change App Protect to App Protect WAF * Apply suggestions from code review Co-authored-by: Jodie Putrino <j.putrino@f5.com> * Rename examples folders; rename docs folder and attempt alias Co-authored-by: Jodie Putrino <j.putrino@f5.com>
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
It's difficult to find our Custom Resources examples in the current folder layout structure. Additionally, a lot of our default examples in the documentation point to the Ingress examples instead of the VS/ TS examples. This PR moves the Ingress examples to their own folder, moves the shared examples to a new folder, and adds references to the VS examples where applicable (including adding a couple of missing examples from VirtualServer).
Checklist
Before creating a PR, run through this checklist and mark each as complete.