Skip to content
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

Closed
bprashanth opened this issue Nov 10, 2016 · 2 comments
Closed

Figure out documentation layout #2

bprashanth opened this issue Nov 10, 2016 · 2 comments

Comments

@bprashanth
Copy link
Contributor

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

@bprashanth bprashanth added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Nov 10, 2016
@bprashanth bprashanth removed the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Nov 10, 2016
@aledbf
Copy link
Member

aledbf commented Nov 10, 2016

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:
captura de pantalla 2016-11-08 a las 10 22 18 a m

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.

@bprashanth
Copy link
Contributor Author

Can you stand up a POC in your repo?

@aledbf aledbf closed this as completed Oct 3, 2017
haoqing0110 referenced this issue in stolostron/management-ingress Mar 5, 2021
* Update Readme

* Add deploy manifest

* Add examples and deploy manifest
haoqing0110 referenced this issue in stolostron/management-ingress Mar 5, 2021
XiShanYongYe-Chang pushed a commit to XiShanYongYe-Chang/ingress-nginx that referenced this issue Feb 25, 2022
@sskserk sskserk mentioned this issue Mar 11, 2022
9 tasks
YngveMolnes pushed a commit to YngveMolnes/ingress-nginx that referenced this issue May 25, 2023
# 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants