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.

Sign up for GitHub

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

Jump to bottom

Add AFP features and update documentation #4061

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add AFP features and update documentation #4061

wants to merge 7 commits into from

Conversation

0xaravindh
Copy link
Member

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:

@0xaravindh
Implement new AFP features, add AFP issue template, and enhance site …
6659ad5 
…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 github-actions bot added the kind/breaking Breaking change label Dec 10, 2024
@github-actions GitHub Actions
Copy link

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.

@0xaravindh 0xaravindh added kind/feature New features for Agones kind/documentation Documentation for Agones labels Dec 10, 2024
@0xaravindh 0xaravindh self-assigned this Dec 10, 2024
@0xaravindh 0xaravindh requested review from gongmax and igooch December 10, 2024 11:47
@agones-bot
Copy link
Collaborator

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 GitHub Actions
Copy link

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
Copy link
Collaborator

Build Succeeded 🥳

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

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

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

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 GitHub Actions
Copy link

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
Copy link
Collaborator

Build Succeeded 🥳

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

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

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

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

@0xaravindh 0xaravindh marked this pull request as ready for review December 14, 2024 02:41
@github-actions GitHub Actions
Copy link

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
Copy link
Collaborator

Build Succeeded 🥳

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

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

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

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 GitHub Actions
Copy link

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 GitHub Actions
Copy link

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
Copy link
Collaborator

Build Succeeded 🥳

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

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

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

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
gongmax reviewed Dec 17, 2024
View reviewed changes
Copy link
Collaborator

@gongmax gongmax left a comment

Choose a reason for hiding this comment

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

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"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gongmax gongmax gongmax left review comments

@markmandel markmandel Awaiting requested review from markmandel

@igooch igooch Awaiting requested review from igooch

At least 1 approving review is required to merge this pull request.

Assignees

@0xaravindh 0xaravindh

Labels
kind/breaking Breaking change kind/documentation Documentation for Agones kind/feature New features for Agones size/XL
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@0xaravindh @agones-bot @gongmax