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

Update documentation issue request template #4229

Closed
jmikell821 opened this issue Nov 8, 2023 · 2 comments
Closed

Update documentation issue request template #4229

jmikell821 opened this issue Nov 8, 2023 · 2 comments
Assignees
Labels
Effort: Medium Issues that take moderate but not substantial time to complete Priority: High Issues that are time-sensitive and/or are of high customer importance v8.11.0

Comments

@jmikell821
Copy link
Contributor

Description

Revise the doc issue request template to include new requirements surrounding Serverless, dev release process, etc.

What needs to be included in the template:

Description
Describe what needs to be documented. Please provide all necessary user details.

Resources
Please include the relative pull request(s) or issue(s).

Which documentation set does this change impact?
Serverless only, ESS only, Serverless and ESS, Unknown.

Feature differences
If you selected Serverless and ESS above, please describe any feature difference between each platform.

When is the feature expected to be released?
Please include the Stack release version and/or Serverless public release date.

Acceptance test criteria
List all the ATC of each action and its intended result. For example: As a user, when [action (e.g., viewing, clicking, selecting, etc.)] I should [insert the expected result].

Prerequisites and privileges
Are there any required role privileges or subscription level tiers?

Test environment
Please include the environment which the docs team can test this feature. Example: https://kibana.siem.estc.dev/. If one isn't available, please list the steps to generate data we can test.

Feature flag limitations
Are there any feature flags that need to be enabled?

Point of contact
Please assign at least one point of contact. Add as many stakeholders as needed -- such as those from dev, design, product management, etc.

@jmikell821 jmikell821 added Priority: High Issues that are time-sensitive and/or are of high customer importance Effort: Medium Issues that take moderate but not substantial time to complete v8.11.0 labels Nov 8, 2023
@jmikell821 jmikell821 self-assigned this Nov 8, 2023
@joepeeples
Copy link
Contributor

I think we can close this now that #4308 is merged, but @jmikell821 I'll let you make the final call.

@jmikell821
Copy link
Contributor Author

Merged #4308.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Effort: Medium Issues that take moderate but not substantial time to complete Priority: High Issues that are time-sensitive and/or are of high customer importance v8.11.0
Projects
None yet
Development

No branches or pull requests

2 participants