Skip to content

Conversation

Kalaiselvi84
Copy link
Contributor

@Kalaiselvi84 Kalaiselvi84 commented Dec 29, 2023

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:

Which issue(s) this PR fixes:

Closes #2706

Special notes for your reviewer:

@Kalaiselvi84 Kalaiselvi84 marked this pull request as ready for review December 29, 2023 01:06
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 16533e6c-02c2-4224-9c77-be23064b3e1e

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/3561/head:pr_3561 && git checkout pr_3561
  • 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.38.0-dev-efa6842-amd64

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.

Is it possible to automatically add kind/documentation label to the issue being created?

@github-actions github-actions bot added the kind/documentation Documentation for Agones label Jan 2, 2024
@Kalaiselvi84
Copy link
Contributor Author

@gongmax, I have added a kind/documentation label to the issues created from the Agones website.

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 1d0fcd41-c614-4b11-8550-bedd982907b5

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/3561/head:pr_3561 && git checkout pr_3561
  • 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.38.0-dev-5ece67b-amd64

@github-actions github-actions bot added the kind/feature New features for Agones label Jan 3, 2024
Comment on lines 14 to 27
{{ $issuesBodyTemplate := `
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

`}}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we rephrase these pre-filled sentences so they sounds more like "documentation issue" rather than "feature request"? I feel the existing bug_report template is more suitable as a reference here but could also use some revise. @roberthbailey @markmandel any suggestions to the wording here?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oooh! nifty to see this get fixed!

This was the template I put together - lemme know what you think:

**Link to page**: 

$pageURL

**Description of documentation issue**:
A clear and concise description of what the problem is with this documentation - e.g. "I find it hard to understand...."

**What improvements to documentation would you like to see?**:
A clear and concise description of what modifications or additions to documentation you would like to see.

I'm not quite sure how to get $pageURL in the middle of the template like that though.

I was also wondering if the bug title should have something more to it than just the page title - but I couldn't come up with anything better.

Copy link
Contributor Author

@Kalaiselvi84 Kalaiselvi84 Jan 3, 2024

Choose a reason for hiding this comment

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

I'm not quite sure how to get $pageURL in the middle of the template like that though.

string formatting(%s) helped to use the variable $pageURL.

I was also wondering if the bug title should have something more to it than just the page title - but I couldn't come up with anything better.

Sorry, I am unsure about this. Could you please provide an example for something more for the bug title?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sorry, I am unsure about this. Could you please provide an example for something more for the bug title?

Yeah, i couldn't think of anything better 😄 that was me just saying "does anyone have any good ideas" ?

Oooh, that made me realise, we should add the area/site tag as well please!

With both tags, we probably don't need anything extra in the tittle - the label metadata will be sufficient.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The area/site label has included to the issues👍🏻

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: cce6c8bd-7822-4dad-accb-d6e7ea9ae2cd

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/3561/head:pr_3561 && git checkout pr_3561
  • 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.38.0-dev-7d94d19-amd64

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: f43c6c08-4a11-4b0b-8de1-2f6b6a19e301

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/3561/head:pr_3561 && git checkout pr_3561
  • 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.38.0-dev-86b12b4-amd64

@gongmax gongmax enabled auto-merge (squash) January 3, 2024 18:28
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 6adfa229-6363-4170-af25-01c88911705b

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/3561/head:pr_3561 && git checkout pr_3561
  • 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.38.0-dev-befe685-amd64

@gongmax gongmax merged commit 1e78d88 into googleforgames:main Jan 3, 2024
@Kalaiselvi84 Kalaiselvi84 deleted the pr-2706 branch March 15, 2024 01:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Documentation for Agones kind/feature New features for Agones size/S size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issues created from the website should use a template and link to the page they were created from
4 participants