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

Update yaml configuration documentation #635

Merged
merged 2 commits into from
Oct 28, 2022

Conversation

markmandel
Copy link
Contributor

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup

/kind documentation

/kind feature
/kind hotfix

What this PR does / Why we need it:

Several updates to make the yaml configuration section easier to understand.

  • Renamed to "file configuration"
  • Connected the file configuration doc to "usage" rather than "proxy".
  • Add admin and maxmind section to proxy.yaml example
  • Add max_mind to json schema in docs
  • Include the two example config files to the file configuration documentation, so there are both examples and the schema to follow.

Which issue(s) this PR fixes:

Work on #546

Special notes for your reviewer:

More documentation review to come, but this section was top of mind because Discord, so wanted to tackle it.

Several updates to make the yaml configuration section easier to
understand.

* Renamed to "file configuration"
* Connected the file configuration doc to "usage" rather than "proxy".
* Add `admin` and `maxmind` section to proxy.yaml example
* Add `max_mind` to json schema in docs
* Include the two example config files to the file configuration
documentation, so there are both examples and the schema to follow.

Work on googleforgames#546
@markmandel markmandel added kind/documentation Improvements or additions to documentation kind/cleanup Refactoring code, fixing up documentation, etc labels Oct 27, 2022
@quilkin-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: e7de701f-a709-4c19-b394-2af08d21aed9

The following development images have been built, and will exist for the next 30 days:

To build this version:

git fetch git@github.com:googleforgames/quilkin.git pull/635/head:pr_635 && git checkout pr_635
cargo build

@XAMPPRocky XAMPPRocky merged commit 89bef3d into googleforgames:main Oct 28, 2022
@markmandel markmandel deleted the examples/admin-port branch October 28, 2022 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Refactoring code, fixing up documentation, etc kind/documentation Improvements or additions to documentation size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants