-
Notifications
You must be signed in to change notification settings - Fork 170
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
Add a document listing all APIcast parameters #192
Conversation
This might be good opportunity to investigate and define #207 |
Not sure how to proceed with this one btw. |
@mayorova good enough for me! If you keep it as a separate commit it can be reverted later. |
83374ca
to
f9d7ea0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Those /v2/
links don't work. V2 branch does not exist any more.
Guess there could be a tool to detect broken links and fail the build.
We will need to change other docs too, so I could do mass replace in all documents if you want me to.
|
||
APIcast v2 has a number of parameters configured as environment variables that can modify the behavior of the gateway. The following reference provides descriptions of these parameters. | ||
|
||
Note that when deploying APIcast v2 with OpenShift, some of thee parameters can be configured via OpenShift template parameters. The latter can be consulted directly in the [template](https://raw.githubusercontent.com/3scale/apicast/v2/openshift/apicast-template.yml). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
those /v2
links don't work anymore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Argh, true.
Probably mass replace would be good. |
I definitely want to add a link checker to the CI build before doing the mass rename so I can verify new links work. |
Meant to be a verbose document (in addition to
.env
andapicast-template.yml
) listing all parameters that can be used to modify the APIcast v2 behavior.There are two links to documents that do not exist yet, but are planned to be added:
/doc/custom-config.md
and/doc/path-routing.md