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

Add a document listing all APIcast parameters #192

Merged
merged 2 commits into from
Jan 10, 2017
Merged

Add a document listing all APIcast parameters #192

merged 2 commits into from
Jan 10, 2017

Conversation

mayorova
Copy link
Contributor

@mayorova mayorova commented Jan 2, 2017

Meant to be a verbose document (in addition to .env and apicast-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

@mikz mikz closed this Jan 9, 2017
@mikz mikz changed the base branch from v2 to master January 9, 2017 14:29
@mikz mikz reopened this Jan 9, 2017
@mikz
Copy link
Contributor

mikz commented Jan 9, 2017

This might be good opportunity to investigate and define #207

@mayorova
Copy link
Contributor Author

mayorova commented Jan 9, 2017

Not sure how to proceed with this one btw.
Should I remove the non-existing links, until the referenced articles are created, and merge this doc?

@mikz
Copy link
Contributor

mikz commented Jan 9, 2017

@mayorova good enough for me! If you keep it as a separate commit it can be reverted later.

@mayorova mayorova changed the title [WIP] Add a document listing all APIcast parameters Add a document listing all APIcast parameters Jan 9, 2017
Copy link
Contributor

@mikz mikz left a 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).
Copy link
Contributor

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Argh, true.

@mayorova
Copy link
Contributor Author

mayorova commented Jan 9, 2017

Probably mass replace would be good.

@mikz
Copy link
Contributor

mikz commented Jan 9, 2017

I definitely want to add a link checker to the CI build before doing the mass rename so I can verify new links work.

@mikz mikz merged commit bdef398 into master Jan 10, 2017
@mikz mikz added the B-current label Jan 10, 2017
@mikz mikz deleted the parameters-doc branch January 10, 2017 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants