Adds instructions for adding and removing field from a CRD

[igooch]

What type of PR is this?

/kind documentation

What this PR does / Why we need it:

Adds instructions necessary for adding and removing a field from a CRD, so that the CRD will be compatible across upgrades.

Which issue(s) this PR fixes:

Closes #3771

Special notes for your reviewer:

[agones-bot]

Build Succeeded 👏

Build Id: 93d5398a-ca56-4b4a-a846-d3be80c9e763

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

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.43.0-dev-c303b36-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.43.0-dev-c303b36-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.43.0-dev-c303b36-linux-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.43.0-dev-c303b36-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.43.0-dev-c303b36-amd64
• Linux C++ SDK (build): agonessdk-1.43.0-dev-c303b36-amd64-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.43.0-dev-c303b36-amd64.zip

A preview of the website (the last 30 builds are retained):

• https://c303b36-dot-preview-dot-agones-images.appspot.com/

To install this version:

• git fetch https://github.com/googleforgames/agones.git pull/3913/head:pr_3913 && git checkout pr_3913
• helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.43.0-dev-c303b36-amd64

[zmerlynn]

This feels like a really weird place - I feel like this is a little more user-centric README in general.

I'm struggling to come up with a better place, though. @markmandel ?

[markmandel]

Agreed, this should be in one of the files listed here: https://github.com/googleforgames/agones?tab=readme-ov-file#development-and-contribution

Quite possibly https://github.com/googleforgames/agones/blob/main/CONTRIBUTING.md since it has all our other style guides.

[igooch]

Would it make sense to follow the same pattern as the SDK and link to the ReadMe from the contributing page?

agones/README.md

Line 56 in 46c5ef9

For Agones client SDK development refer to [Developing, Testing, and Building Agones Client SDKs](sdks/README.md).

[markmandel]

This has both a style guide as well as a development guide - which is not a bad thing, but we've never quite done it like this, so it's a little trickier to put in an existing place.

Would it make sense to follow the same pattern as the SDK and link to the ReadMe from the contributing page?

What README would you put it in? There isn't really a spot that I can think of. We could always add a docs folder to https://github.com/googleforgames/agones/tree/main/build though? But open to your suggestions.

It could possibly be a section in https://github.com/googleforgames/agones/blob/main/build/README.md#testing-and-building ?

Or take a stab at taking apart https://github.com/googleforgames/agones/blob/main/build/README.md into some sub-sectioned files, even it's just some basics - and it could be the beginning of making that a better experience - right now it's not terrific.

[igooch]

What README would you put it in?

The one it's in now -- agones/install/helm/agones/README.md. I figured it made the most sense since that's where the installation files are, and sparse readme already existed. Or we could add a readme into the agones/install/helm/agones/templates/crds directory where the CRDs are? I'm not sure it belongs in the testing-and-building section, simply because most people won't be amending the CRDs.

Or take a stab at taking apart https://github.com/googleforgames/agones/blob/main/build/README.md into some sub-sectioned files

We should probably create a new GitHub issue for this.

[agones-bot]

Build Succeeded 🥳

Build Id: 6af5ca43-53b4-4cac-aaf1-7ba559f5175f

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

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.43.0-dev-f5997d9
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.43.0-dev-f5997d9
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.43.0-dev-f5997d9-linux
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.43.0-dev-f5997d9
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.43.0-dev-f5997d9
• Linux C++ SDK (build): agonessdk-1.43.0-dev-f5997d9-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.43.0-dev-f5997d9.zip

A preview of the website (the last 30 builds are retained):

• https://f5997d9-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3913/head:pr_3913 && git checkout pr_3913
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.43.0-dev-f5997d9

[markmandel]

This has both a style guide as well as a development guide - which is not a bad thing, but we've never quite done it like this, so it's a little trickier to put in an existing place.

Would it make sense to follow the same pattern as the SDK and link to the ReadMe from the contributing page?

What README would you put it in? There isn't really a spot that I can think of. We could always add a docs folder to https://github.com/googleforgames/agones/tree/main/build though? But open to your suggestions.

It could possibly be a section in https://github.com/googleforgames/agones/blob/main/build/README.md#testing-and-building ?

Or take a stab at taking apart https://github.com/googleforgames/agones/blob/main/build/README.md into some sub-sectioned files, even it's just some basics - and it could be the beginning of making that a better experience - right now it's not terrific.

[agones-bot]

Build Succeeded 🥳

Build Id: 3df5a1cc-1e41-44b4-baf2-72dae163f00e

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

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.43.0-dev-569d082
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.43.0-dev-569d082
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.43.0-dev-569d082-linux
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.43.0-dev-569d082
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.43.0-dev-569d082
• Linux C++ SDK (build): agonessdk-1.43.0-dev-569d082-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.43.0-dev-569d082.zip

A preview of the website (the last 30 builds are retained):

• https://569d082-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3913/head:pr_3913 && git checkout pr_3913
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.43.0-dev-569d082

[agones-bot]

Build Succeeded 🥳

Build Id: e007e125-cc64-495d-a112-12d62df984ef

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

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.44.0-dev-9dfbd81
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.44.0-dev-9dfbd81
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.44.0-dev-9dfbd81-linux
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.44.0-dev-9dfbd81
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.44.0-dev-9dfbd81
• Linux C++ SDK (build): agonessdk-1.44.0-dev-9dfbd81-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.44.0-dev-9dfbd81.zip

A preview of the website (the last 30 builds are retained):

• https://9dfbd81-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3913/head:pr_3913 && git checkout pr_3913
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.44.0-dev-9dfbd81