Skip to content

Commit 4701b33

Browse files
bmorelli25georgewallaceshainaraskasflorent-leborgnecolleenmcginnis
authored
Update Codeowners, Issues, and Project automation (#609)
## What * Adds codeowners * Updates issue template ordering, wording, and labeling * Updates project automation to support new project boards ## How issues/triaging will work * **Elastic employees** will use the Internal Docs Template. This template requires more inputs to better scope issues for writers to wrk on. * **Community members** will use the Community Docs Template. This template requires less input as we want it to be easy for community members to contribute. * There are two additional templates for specific types of feedback: * API docs feedback template * UI text template * Finally, there is a website feedback template that is only for issues coming directly from our published docs If a writer opens an issue in their teams area, they are expected to remove the `needs-team` label and apply the appropriate docs team labels. For all other instances of issues opened, the assigned "on call" writer will triage issues by adding them to their teams product boards and fixing easy issues. --------- Signed-off-by: bmorelli25 <[email protected]> Co-authored-by: George Wallace <[email protected]> Co-authored-by: shainaraskas <[email protected]> Co-authored-by: florent-leborgne <[email protected]> Co-authored-by: Colleen McGinnis <[email protected]>
1 parent 3704f29 commit 4701b33

File tree

7 files changed

+93
-28
lines changed

7 files changed

+93
-28
lines changed

.github/CODEOWNERS

Lines changed: 64 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,65 @@
1-
/.github/ @elastic/doc-leads
2-
/.github/workflows/ @elastic/docs-engineering
1+
# Unless a later match takes precedence, someone on the docs team must review all PRs to this repo
2+
* @elastic/docs
33

4-
/serverless/ @elastic/platform-docs
5-
/serverless/serverless-changelog.asciidoc @elastic/docs
4+
# Templates, workflows, and config
5+
/.github/ @elastic/doc-leads
6+
/.github/workflows/ @elastic/docs-engineering
7+
/acrolinx/ @elastic/doc-leads
8+
9+
# The docs
10+
/cloud-account/ @elastic/admin-docs
11+
/deploy-manage/ @elastic/admin-docs
12+
/explore-analyze/ @elastic/core-docs @elastic/experience-docs
13+
/extend/ @elastic/core-docs
14+
/get-started/ @elastic/core-docs
15+
16+
/manage-data/ @elastic/admin-docs
17+
/manage-data/data-store/ @elastic/admin-docs @elastic/developer-docs
18+
/manage-data/ingest/ @elastic/ingest-docs
19+
20+
/reference/ @elastic/docs
21+
/reference/apm-agents/ @elastic/ingest-docs
22+
/reference/data-analysis/ @elastic/docs
23+
/reference/data-analysis/observability/ @elastic/experience-docs
24+
/reference/data-analysis/kibana/ @elastic/experience-docs
25+
/reference/data-analysis/machine-learning/ @elastic/developer-docs
26+
/reference/data-analysis/observability/ @elastic/experience-docs
27+
/reference/elasticsearch/clients/ @elastic/developer-docs
28+
/reference/fleet/ @elastic/ingest-docs
29+
/reference/glossary/ @elastic/docs
30+
/reference/ingestion-tools/ @elastic/ingest-docs
31+
/reference/observability/ @elastic/experience-docs
32+
/reference/search/ @elastic/developer-docs
33+
/reference/security/ @elastic/experience-docs
34+
35+
/release-notes/ @elastic/docs
36+
37+
/release-notes/apm-agents/ @elastic/ingest-docs
38+
/release-notes/elastic-cloud-serverless/ @elastic/admin-docs
39+
/release-notes/elastic-observability/ @elastic/ski-docs
40+
/release-notes/elastic-security/ @elastic/ski-docs
41+
/release-notes/elasticsearch-clients/ @elastic/developer-docs
42+
/release-notes/fleet-elastic-agent/ @elastic/ingest-docs
43+
/release-notes/intro/ @elastic/docs
44+
45+
/solutions/ @elastic/experience-docs @elastic/developer-docs
46+
/solutions/observability/ @elastic/experience-docs
47+
/solutions/observability/get-started/ @elastic/ski-docs
48+
/solutions/search/ @elastic/developer-docs
49+
/solutions/security/ @elastic/experience-docs
50+
51+
/troubleshoot/ @elastic/docs
52+
/troubleshoot/deployments/ @elastic/admin-docs
53+
/troubleshoot/elasticsearch/ @elastic/admin-docs
54+
/troubleshoot/ingest/ @elastic/ingest-docs
55+
/troubleshoot/kibana/ @elastic/admin-docs @elastic/experience-docs
56+
/troubleshoot/monitoring/ @elastic/admin-docs @elastic/experience-docs
57+
/troubleshoot/observability/ @elastic/ski-docs
58+
/troubleshoot/security/ @elastic/ski-docs
59+
60+
# Raw migrated files
61+
/raw-migrated-files/ @elastic/docs
62+
63+
# Legacy serverless docs
64+
/serverless/ @elastic/admin-docs
65+
/serverless/serverless-changelog.asciidoc @elastic/docs

.github/ISSUE_TEMPLATE/community-request.yaml renamed to .github/ISSUE_TEMPLATE/a-community-request.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
name: "Community documentation request"
2-
description: Request a documentation change or enhancement.
3-
title: "[Request]: "
4-
labels: ["Request", "community"]
2+
description: An issue template for non-Elastic employees to request changes to the documentation.
3+
title: "[Community]: "
4+
labels: ["community"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Hi 👋. Thanks for taking the time to fill out this request!
10-
This form will create an issue that Elastic's docs team will triage and prioritize.
11-
You can also open a PR instead.
9+
This issue template is for non-Elastic employees to request changes to the documentation. **If you are an Elastic employee, please use the internal issue template instead.**
10+
11+
This form will create an issue that Elastic's docs team will triage and prioritize. You can also open a PR instead. Thanks for taking the time to fill out this request!
1212
- type: textarea
1313
id: link
1414
attributes:

.github/ISSUE_TEMPLATE/internal-request.yaml renamed to .github/ISSUE_TEMPLATE/b-internal-request.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: "Internal documentation request (Elastic employees)"
2-
description: Request a documentation change or enhancement for any supported release.
3-
title: "[REQUEST]: "
4-
labels: ["request", "Team:Docs"]
2+
description: An issue template for Elastic employees to request improvements, additions, or changes to the documentation.
3+
title: "[Internal]: "
54
body:
65
- type: markdown
76
attributes:

.github/ISSUE_TEMPLATE/api-feedback.yaml renamed to .github/ISSUE_TEMPLATE/c-api-feedback.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: "API docs feedback"
22
description: Tell us about your experience with Elastic API documentation.
3-
title: "[Feedback]: "
4-
labels: ["feedback", "community"]
3+
title: "[API]: "
4+
labels: ["api-feedback"]
55
body:
66
- type: markdown
77
attributes:

.github/ISSUE_TEMPLATE/issue-report.yaml renamed to .github/ISSUE_TEMPLATE/z-issue-report.yaml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
name: "Docs issue"
2-
description: Report documentation issues such as inaccuracies, broken links, typos, or missing information.
3-
title: "[Issue]: "
4-
labels: ["triage"]
1+
name: "Website issue"
2+
description: This issue template should only be used when navigating directly from elastic.co.
3+
title: "[Website]: "
4+
labels: ["source:web"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Hi 👋. Thanks for taking the time to fill out this issue report!
10-
This form will create an issue that Elastic's docs team will triage and prioritize.
11-
You can also open a PR instead.
9+
Hi 👋. Thanks for taking the time to fill out this issue report! This form will create an issue that Elastic's docs team will triage and prioritize. You can also open a PR instead.
1210
- type: dropdown
1311
attributes:
1412
label: Type of issue

.github/workflows/add-to-board.yml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ jobs:
1212
route:
1313
runs-on: ubuntu-latest
1414
if: |
15+
github.event.label.name == 'team:Ingest' ||
16+
github.event.label.name == 'team:Experience' ||
17+
github.event.label.name == 'team:Admin' ||
18+
github.event.label.name == 'team:Developer' ||
1519
github.event.label.name == 'team:DocsEng' ||
1620
github.event.label.name == 'team:Obs' ||
1721
github.event.label.name == 'team:Platform' ||
@@ -21,12 +25,16 @@ jobs:
2125
env:
2226
PROJECT_ID_MAP: |
2327
{
24-
"team:DocsEng": "1625",
25-
"team:Obs": "649",
26-
"team:Platform": "1232",
27-
"team:Projects": "1415",
28-
"team:Search": "726",
29-
"team:Security": "1034"
28+
"team:Ingest": "649",
29+
"team:Experience": "1034",
30+
"team:Admin": "1927",
31+
"team:Developer": "726",
32+
"team:DocsEng": "1625",
33+
"team:Obs": "649",
34+
"team:Platform": "1232",
35+
"team:Projects": "1415",
36+
"team:Search": "726",
37+
"team:Security": "1034"
3038
}
3139
steps:
3240
- name: Remove needs-team label

0 commit comments

Comments
 (0)