Add AFP features and update documentation #4061

0xaravindh · 2024-12-10T11:45:51Z

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
/kind release

What this PR does / Why we need it:

Implement new AFP features, add AFP issue template, and enhance site documentation for AFP guidelines

Introduced a new GitHub issue template for feature proposals
Updated site documentation to include detailed instructions for the Agones Feature Proposal (AFP) process
Included metadata schema and workflow explanations in the documentation
Added references to the AFP template and review process

Which issue(s) this PR fixes:

Works on #3882

Special notes for your reviewer:

…documentation for AFP guidelines - Introduced a new GitHub issue template for feature proposals - Updated site documentation to include detailed instructions for the Agones Feature Proposal (AFP) process - Included metadata schema and workflow explanations in the documentation - Added references to the AFP template and review process

github-actions · 2024-12-10T11:46:09Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-12-10T12:17:09Z

Build Failed 😭

Build Id: 35e336ed-74ee-4f84-bc8f-186318321d6d

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

github-actions · 2024-12-11T07:22:23Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-12-11T08:26:44Z

Build Succeeded 🥳

Build Id: c581a967-0dc9-4082-96fa-7838dd79a85c

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.46.0-dev-cac907a
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.46.0-dev-cac907a
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.46.0-dev-cac907a-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.46.0-dev-cac907a
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.46.0-dev-cac907a
Linux C++ SDK (build): agonessdk-1.46.0-dev-cac907a-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.46.0-dev-cac907a.zip

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

https://cac907a-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4061/head:pr_4061 && git checkout pr_4061
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.46.0-dev-cac907a

github-actions · 2024-12-13T09:04:35Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-12-13T10:05:59Z

Build Succeeded 🥳

Build Id: 8d6f39d9-0a4f-4a38-9166-e9d3ebb348e7

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.46.0-dev-450c8b5
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.46.0-dev-450c8b5
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.46.0-dev-450c8b5-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.46.0-dev-450c8b5
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.46.0-dev-450c8b5
Linux C++ SDK (build): agonessdk-1.46.0-dev-450c8b5-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.46.0-dev-450c8b5.zip

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

https://450c8b5-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4061/head:pr_4061 && git checkout pr_4061
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.46.0-dev-450c8b5

github-actions · 2024-12-16T05:19:21Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-12-16T06:53:30Z

Build Succeeded 🥳

Build Id: 96aa270d-e67e-4e91-9e18-5cfd3d2de7b4

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.46.0-dev-12c4385
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.46.0-dev-12c4385
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.46.0-dev-12c4385-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.46.0-dev-12c4385
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.46.0-dev-12c4385
Linux C++ SDK (build): agonessdk-1.46.0-dev-12c4385-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.46.0-dev-12c4385.zip

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

https://12c4385-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4061/head:pr_4061 && git checkout pr_4061
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.46.0-dev-12c4385

github-actions · 2024-12-17T04:28:15Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

github-actions · 2024-12-17T04:29:07Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-12-17T05:36:49Z

Build Succeeded 🥳

Build Id: 61d23164-db1d-4163-b70e-9122ea736451

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.46.0-dev-92baa26
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.46.0-dev-92baa26
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.46.0-dev-92baa26-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.46.0-dev-92baa26
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.46.0-dev-92baa26
Linux C++ SDK (build): agonessdk-1.46.0-dev-92baa26-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.46.0-dev-92baa26.zip

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

https://92baa26-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4061/head:pr_4061 && git checkout pr_4061
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.46.0-dev-92baa26

gongmax

Looks like you were following exactly how KEP is setup, which I don't think is necessary since it's too comprehensive for us. For our case, we just need to document the process of AFP, which is majorly the below part in the description of #3882 (which majorly including creates a PR and an issue), document the structure of the AFP PR, and probably also provide an example AFP PR template in the agones/docs/proposal folder. The structure of the AFP PR can be similar as the top level structure of this design doc: #2716

The process of AFP, quote from #3882 :
"When someone wants to write a design, start with an issue outlining the problem. After that, they have two options:
For smaller changes, writing it in the issue is still fine.
For larger changes, or when asked by a maintainer because the conversation is getting unwieldy, they submit an AFP PR
An AFP PR is as simple as a PR that adds a file in agones/docs/features. The PR should be titled AFP-00x and the file named 00x-feature-name.md.
Everyone can then participate on the PR, selecting text they want to comment on and having conversations there.
When we reach lazy consensus, a maintainer can approve and submit.
Every AFP OR should be tied back to an issue"

github-actions · 2025-02-03T05:24:24Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2025-02-03T06:31:17Z

Build Succeeded 🥳

Build Id: f8bd7609-9636-4d99-84c7-9186fbba2821

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.47.0-dev-567d498
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.47.0-dev-567d498
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.47.0-dev-567d498-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.47.0-dev-567d498
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.47.0-dev-567d498
Linux C++ SDK (build): agonessdk-1.47.0-dev-567d498-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.47.0-dev-567d498.zip

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

https://567d498-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4061/head:pr_4061 && git checkout pr_4061
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.47.0-dev-567d498

github-actions · 2025-02-15T04:45:06Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2025-02-15T05:54:43Z

Build Failed 😭

Build Id: a5c91ba0-70b6-44b0-aa87-8c66440de017

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

github-actions · 2025-02-26T07:30:05Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2025-02-26T08:05:59Z

Build Failed 😭

Build Id: f6a4b766-fcf1-46a8-b6cc-1ecb3926b163

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2025-02-26T19:32:33Z

Build Succeeded 🥳

Build Id: c3fa95e9-7bf5-45ac-9414-2c206eb50d64

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.48.0-dev-6c62820
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.48.0-dev-6c62820
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.48.0-dev-6c62820-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.48.0-dev-6c62820
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.48.0-dev-6c62820
Linux C++ SDK (build): agonessdk-1.48.0-dev-6c62820-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.48.0-dev-6c62820.zip

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

https://6c62820-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4061/head:pr_4061 && git checkout pr_4061
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.48.0-dev-6c62820

gongmax · 2025-02-28T20:48:25Z

.github/ISSUE_TEMPLATE/agones_feature_proposal.md

@@ -0,0 +1,34 @@
+---


I think it's ok to just keep the existing feature_request.md file. In that file, we can add the following entry:
"
Link to the Agones Feature Proposal (if any)
The link to the AFP PR.
"

gongmax · 2025-02-28T21:00:36Z

docs/proposals/0000-afp-process/README.md

+Without a standardized mechanism for describing important features, our
+talented technical writers and product managers struggle to weave a coherent
+narrative explaining why a particular release is important. Additionally, adopters
+of critical infrastructure such as Agones need a forward-looking roadmap in
+order to plan their adoption strategies.


This part can be removed.

gongmax · 2025-02-28T21:29:52Z

docs/proposals/0000-afp-process/README.md

+
+AFPs are checked into the Features repo under the `/docs/proposals` directory.
+
+New AFPs can be checked in with a file name in the form of `draft-YYYYMMDD-my-title.md`.


Let's keep the file name simple as 00x-feature-name, where 00x is a an incremental AFP number. And the PR should be titled with AFP-00x

gongmax · 2025-02-28T21:32:23Z

docs/proposals/0000-afp-process/README.md

+No other changes should be put in that PR so that it can be approved quickly and minimize merge conflicts.
+The AFP number can also be done as part of the initial submission if the PR is likely to be uncontested and merged quickly.
+
+### AFP Editor Role


Let's keep it simple and not have this role. Author, reviewer, approver (probabaly same as reviewer) should be enough, and reviewer, approver can take the responsibility of the editor

gongmax · 2025-02-28T21:33:24Z

docs/proposals/0000-afp-process/README.md

+[Kubernetes AFP process]: https://github.com/kubernetes/enhancements/tree/master/afps
+[Rust RFC process]: https://github.com/rust-lang/rfcs
+
+## Drawbacks


Seems not related to our case, can remove this part.

gongmax · 2025-02-28T21:44:55Z

docs/proposals/NNNN-afp-template/README.md

+
+- [ ] **Create an issue in agones/proposals**
+  When filing an feature tracking issue, please make sure to complete all
+  fields in that template. One of the fields asks for a link to the AFP. You


Which template this refers to?

gongmax · 2025-02-28T21:46:57Z

docs/proposals/README.md

@@ -0,0 +1,64 @@
+# Agones Feature Proposals (AFPs)


Does this README serves similar purpose of the files in that 0000-afp-process folder? Seems like they both give an introduction of what AFP's process looks like.

gongmax · 2025-02-28T21:54:19Z

site/content/en/docs/Contribute/agones-feature-proposal.md

+
+### How to Submit an AFP
+
+To submit a new AFP, follow the instructions provided in the official AFP template. This template outlines the required sections and metadata, such as the title, authors, reviewers, and approval statuses. AFPs are stored in the project's **docs/proposals** directory, with filenames formatted as `NNNN-my-title.md`. The document undergoes iterative updates, with changes tracked via version control.


Can we add a link to the template?

gongmax · 2025-02-28T21:54:37Z

site/content/en/docs/Contribute/agones-feature-proposal.md

+- **[AFP Template](#)**: A detailed template for creating an AFP.
+- **[AFP Metadata](#)**: Information on the metadata required for each AFP.


These two links do not work as expected

gongmax · 2025-02-28T21:55:23Z

site/content/en/docs/Contribute/agones-feature-proposal.md

+### Examples of AFPs
+
+Here are some example AFPs that have been proposed or implemented in Agones:
+
+- **[123-AFP: Example Feature](#)**: Description of a feature proposal.
+- **[124-AFP: Example Architecture Change](#)**: Description of a major architectural change proposal.


We don't have any example yet, no value to provide these fake links.

github-actions bot added the kind/breaking Breaking change label Dec 10, 2024

github-actions bot added the size/XL label Dec 10, 2024

0xaravindh added kind/feature New features for Agones kind/documentation Documentation for Agones labels Dec 10, 2024

0xaravindh requested a review from markmandel December 10, 2024 11:46

0xaravindh self-assigned this Dec 10, 2024

0xaravindh requested review from gongmax and igooch December 10, 2024 11:47

0xaravindh added 2 commits December 11, 2024 04:10

Merge branch 'main' of https://github.com/0xaravindh/agones into afp

9afb297

Fix broken links

cac907a

Merge branch 'googleforgames:main' into afp

450c8b5

0xaravindh marked this pull request as ready for review December 14, 2024 02:41

Merge branch 'googleforgames:main' into afp

12c4385

fix broken link

d8f93b9

update_site_changes

92baa26

gongmax reviewed Dec 17, 2024

View reviewed changes

Merge branch 'googleforgames:main' into afp

567d498

Merge branch 'googleforgames:main' into afp

c16e870

Merge branch 'googleforgames:main' into afp

6c62820

gongmax reviewed Feb 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add AFP features and update documentation #4061

Add AFP features and update documentation #4061

0xaravindh commented Dec 10, 2024

github-actions bot commented Dec 10, 2024

agones-bot commented Dec 10, 2024

github-actions bot commented Dec 11, 2024

agones-bot commented Dec 11, 2024

github-actions bot commented Dec 13, 2024

agones-bot commented Dec 13, 2024

github-actions bot commented Dec 16, 2024

agones-bot commented Dec 16, 2024

github-actions bot commented Dec 17, 2024

github-actions bot commented Dec 17, 2024

agones-bot commented Dec 17, 2024

gongmax left a comment

github-actions bot commented Feb 3, 2025

agones-bot commented Feb 3, 2025

github-actions bot commented Feb 15, 2025

agones-bot commented Feb 15, 2025

github-actions bot commented Feb 26, 2025

agones-bot commented Feb 26, 2025

agones-bot commented Feb 26, 2025

gongmax Feb 28, 2025

gongmax Feb 28, 2025

gongmax Feb 28, 2025

gongmax Feb 28, 2025

gongmax Feb 28, 2025

gongmax Feb 28, 2025

gongmax Feb 28, 2025

gongmax Feb 28, 2025

gongmax Feb 28, 2025

gongmax Feb 28, 2025


		AFPs are checked into the Features repo under the `/docs/proposals` directory.

		New AFPs can be checked in with a file name in the form of `draft-YYYYMMDD-my-title.md`.


		### How to Submit an AFP

		To submit a new AFP, follow the instructions provided in the official AFP template. This template outlines the required sections and metadata, such as the title, authors, reviewers, and approval statuses. AFPs are stored in the project's docs/proposals directory, with filenames formatted as `NNNN-my-title.md`. The document undergoes iterative updates, with changes tracked via version control.

		- [AFP Template](#): A detailed template for creating an AFP.
		- [AFP Metadata](#): Information on the metadata required for each AFP.

Add AFP features and update documentation #4061

Are you sure you want to change the base?

Add AFP features and update documentation #4061

Conversation

0xaravindh commented Dec 10, 2024

github-actions bot commented Dec 10, 2024

agones-bot commented Dec 10, 2024

github-actions bot commented Dec 11, 2024

agones-bot commented Dec 11, 2024

github-actions bot commented Dec 13, 2024

agones-bot commented Dec 13, 2024

github-actions bot commented Dec 16, 2024

agones-bot commented Dec 16, 2024

github-actions bot commented Dec 17, 2024

github-actions bot commented Dec 17, 2024

agones-bot commented Dec 17, 2024

gongmax left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 3, 2025

agones-bot commented Feb 3, 2025

github-actions bot commented Feb 15, 2025

agones-bot commented Feb 15, 2025

github-actions bot commented Feb 26, 2025

agones-bot commented Feb 26, 2025

agones-bot commented Feb 26, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment