search

googleforgames / quilkin

Quilkin is a non-transparent UDP proxy specifically designed for use with large scale multiplayer dedicated game server deployments, to ensure security, access control, telemetry data, metrics and more.
Apache License 2.0
1.28k stars 91 forks source link

Documentation for xDS Delta API #885

Open markmandel opened 8 months ago

markmandel commented 8 months ago

With the implementation of #792 we should update our xDS documentation to reflect this change.

Just digging into the implementation, these are the pages that need updating:

I don't think there is anything else?

XAMPPRocky commented 8 months ago

I think it depends on #884 because the changes in that issue would change the documentation, since we would change the types, and thus the documentation, and I'm reluctant to write docs that'd only be valid for one commit.

markmandel commented 8 months ago

I think it depends on #884 because the changes in that issue would change the documentation, since we would change the types, and thus the documentation, and I'm reluctant to write docs that'd only be valid for one commit.

I guess the only mitigating factor would be that if we want to cut a release, we would have an undocumented API surface at release time -- but we can make that decision when we are ready to make a new release 👍🏻

XAMPPRocky commented 8 months ago

I guess the only mitigating factor would be that if we want to cut a release

I think regardless of this specific feature, I think we want to move away from instant feature stability from version releases. As once we've started shipping "stable" versions, we're still going to want to merge features incrementally.

markmandel commented 8 months ago

I think regardless of this specific feature, I think we want to move away from instant feature stability from version releases. As once we've started shipping "stable" versions, we're still going to want to merge features incrementally.

100% Agreed (we use feature gates in Agones for exactly the same reason) - but even some kind of non-stable documentation with a warning of stability guarantee, would be useful if we do cut a release, so that end users can at least play with it and give feedback, etc.

For example, this is what we do on Agones: https://agones.dev/site/docs/guides/player-tracking/

Not wedded to the format, but it's definitely useful for exactly the reasons you describe 👍🏻