-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Figure out documentation layout #2
Comments
Using https://apiblueprint.org/ is possible to express one or more test cases just using markdown files. Is possible to extend the recognized tags so is possible to add particular things like all the related to kubernetes. Something like this: with this approach is easy to add new tests (e2e), any user can build a new test case and use this format as a standard way to express the intent using standard kubernetes api objects and also enable the use of custom docker user images. |
Can you stand up a POC in your repo? |
* Update Readme * Add deploy manifest * Add examples and deploy manifest
do not run e2e first
# This is the 1st commit message: Add feature flag to disable annotation prefix check in admission controller # This is the commit message kubernetes#2: Add log message for when ingress hits annotation check Indicates that the correct environment variable is set. Does not log on absence of environment variable. # This is the commit message kubernetes#3: Add flag for disabling legacy ingress class annotation prefix check # This is the commit message kubernetes#4: Remove negation from if statement on annotation prefix check # This is the commit message kubernetes#5: Add logline to indicate annotation prefix check is skipped
We have a chance to improve the way we handle docs/examples since we're moving to a new repo, lets not waste it. Ideas on how we should lay out examples ?
@aledbf @mdelio @justinsb
One idea mentioned was to use https://github.com/apiaryio/api-blueprint/tree/master/examples to handle documentation and testing for cross platform cases kubernetes-retired/contrib#775
The text was updated successfully, but these errors were encountered: