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.

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

Create docs issue fourms #299

Closed
wants to merge 1 commit into from
Closed

Create docs issue fourms #299

wants to merge 1 commit into from

Conversation

tmob03
Copy link
Contributor

@tmob03 tmob03 commented Jun 28, 2022

Resolves #268

@AWildErin
Copy link
Member

I don't think we need feature and bug issue templates here do we? Seems a bit weird imo to have them on the docs repo

@tmob03
Copy link
Contributor Author

tmob03 commented Jul 1, 2022

Idk, the issue said most or all, so I took out the one's the definitely aren't needed for the docs website, these two felt a bit unneeded but I thought maybe they might have a use

@AWildErin
Copy link
Member

Would be worth somebody else chiming in with their opinion from Momentum, but I don't feel they're really required in the docs repo personally

@hexaflexahexagon
Copy link
Member

Could maybe update them to "new / update / deletion" or something

@tmob03
Copy link
Contributor Author

tmob03 commented Jul 1, 2022

Oh that's a good idea i'll do that

@tmob03
Copy link
Contributor Author

tmob03 commented Jul 1, 2022

Alright I did that, three new labels to add: "creation", "deletion", and "update" in place of the standard "documentation" label.

Copy link
Member

@braem braem left a comment

Choose a reason for hiding this comment

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

Quite often we'll have issues revolving around a specific area (internal merge request) which adds, changes, and removes documentation all at once (movement refactor was a good example). So I think we should consolidate all those into 1 form of 'Documentation'.

We do however need feature and bug submissions for the website itself. Eg. Adding the ability to display default/min/max values from metadata was a feature, and fixing broken links was a bug. Neither of those related were actual documentation.

@hexaflexahexagon
Copy link
Member

Good points by brae. Looking at the existing issue labels we have now I'd suggest something like:

  • Documentation (including OPTIONAL sections for add/edit/remove so you can have one, multiple, or all populated with info)
  • Technical Guide (used for like shaders and mapping guides for new features)
  • Gamemode Guide (maybe? we have a tag for this but IDK how frequently these types of things would actually come up. all the gamemode guides are stubbed right now so it'd just be for modification suggestions)
  • Website (meta changes that don't change documentation themselves but rather the website's config or styling or something
  • Miscellaneous (maybe, because some platforms still won't let you add blank issues without using a template)

@tmob03 tmob03 closed this Jul 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Transfer issue templates from website
4 participants