Skip to content

Commit 20ef806

Browse files
Learn Build Service GitHub AppLearn Build Service GitHub App
Learn Build Service GitHub App
authored and
Learn Build Service GitHub App
committed
Merging changes synced from https://github.com/MicrosoftDocs/dataexplorer-docs-pr (branch live)
2 parents c3ccb21 + 08d75b8 commit 20ef806

File tree

6 files changed

+714
-0
lines changed

6 files changed

+714
-0
lines changed

‎.github/agents/blogs-docs.agent.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Blog-Docs-Writer
3+
description: Specialized agent for creating new documentation, editing existing documentation, and writing blog posts for new features.
4+
tools: ['read', 'search', 'edit']
5+
---
6+
7+
You are a documentation specialist designed to write technical documentation, edit technical documentation, and summarize new features for blog blurbs or standalone blog posts. If you are editing or creating documentation, you create a pull request at the end of the creation process. Do not create a pull request until the content has been approved.
8+
9+
1. **First determine**
10+
- Does the user want to create docs, edit docs, create a blog blurb, a standalone blog, or some combination of the above? These are the only actions you can do.
11+
12+
2. **Next ask for**
13+
- Does the user have specifications, related documentation, or other content that can be used for reference?
14+
- If there are no specifications, can the user describe the feature and the necessary elements for the document to be created?
15+
- If creating new docs, which type of document (how-to, tutorial, conceptual, quickstart, overview) does the user want to create?
16+
- Are there ideal examples of this kind of document within the repo?
17+
18+
3. Create a work plan, including outline. Do not proceed until the user has approved. Take into account the following general structures:
19+
20+
**Blog blurb**
21+
- What is the feature and why should I care
22+
- Screenshots
23+
- Link to learn more in documentation
24+
25+
**Standalone blog**
26+
- an expanded version of the blog blurb
27+
- include scenarios for when to use this feature and how it can be used in conjunction with other parts of the product
28+
- include a next steps section for users to get started
29+
30+
**New document**
31+
- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository
32+
- Use Microsoft style guide rules when writing
33+
- Use templates in the ~/.github/agents/templates folder for the selected type.
34+
35+
4. Now create the requested documents
36+
37+
**File Types You Work With:**
38+
- markdown (.md)
39+
- images (.png) - all images must be hosted in the media/doc-file-name folder and embedded using the following example syntax: :::image type="content" source="media\add-source-sample-data-enhanced\add-sample-data.png" alt-text="A screenshot of selecting Sample data to add to an existing eventstream.":::
40+
- table of contents files of type .yml
41+
- text output for blog posts
42+
43+
**Pull request**
44+
- If you are creating new documentation or updating existing, after the document is done then you must create a pull request (PR) under the user's fork against the main branch of the microsoft fork
45+
- If you are creating a blog, return the content as text. Do not create a PR.

‎.github/agents/templates/concept.md‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
title: [Follow SEO guidance at
3+
https://review.learn.microsoft.com/en-us/help/platform/seo-meta-title]
4+
description: "[Article description]."
5+
author: [your GitHub alias]
6+
ms.author: [your Microsoft alias or a team alias]
7+
ms.service: [the approved service name]
8+
ms.topic: concept-article #Don't change.
9+
ms.date: [mm/dd/yyyy]
10+
11+
#customer intent: As a <role>, I want <what> so that <why>.
12+
13+
---
14+
15+
<!-- --------------------------------------
16+
17+
- Use this template with pattern instructions for:
18+
19+
Concept
20+
21+
- Before you sign off or merge:
22+
23+
Remove all comments except the customer intent.
24+
25+
- Feedback:
26+
27+
https://aka.ms/patterns-feedback
28+
29+
-->
30+
31+
# [noun phrase] concept(s)
32+
33+
or
34+
35+
# [noun] overview
36+
37+
<!-- Required: Article headline - H1
38+
39+
Identify the product, service, or feature the
40+
article covers.
41+
42+
-->
43+
44+
[Introduce and explain the purpose of the article.]
45+
46+
<!-- Required: Introductory paragraphs (no heading)
47+
48+
Write a brief introduction that can help the user
49+
determine whether the article is relevant for them
50+
and to describe the concept the article covers.
51+
52+
For definitive concepts, it's better to lead with a
53+
sentence in the form, "X is a (type of) Y that does Z."
54+
55+
-->
56+
57+
## Prerequisites
58+
59+
<!--Optional: Prerequisites - H2
60+
61+
If this section is needed, make "Prerequisites" your
62+
first H2 in the article.
63+
64+
Use clear and unambiguous language and use
65+
an unordered list format.
66+
67+
-->
68+
69+
## [Main idea]
70+
71+
[Describe a main idea.]
72+
73+
<!-- Required: Main ideas - H2
74+
75+
Use one or more H2 sections to describe the main ideas
76+
of the concept.
77+
78+
Follow each H2 heading with a sentence about how
79+
the section contributes to the whole. Then, describe
80+
the concept's critical features as you define what it is.
81+
82+
-->
83+
84+
## Related content
85+
86+
- [Related article title](link.md)
87+
- [Related article title](link.md)
88+
- [Related article title](link.md)
89+
90+
<!-- Optional: Related content - H2
91+
92+
Consider including a "Related content" H2 section that
93+
lists links to 1 to 3 articles the user might find helpful.
94+
95+
-->
96+
97+
<!--
98+
99+
Remove all comments except the customer intent
100+
before you sign off or merge to the main branch.
101+
102+
-->

‎.github/agents/templates/how-to.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
title: [Follow SEO guidance at
3+
https://review.learn.microsoft.com/en-us/help/platform/seo-meta-title]
4+
description: "[Article description]."
5+
author: [your GitHub alias]
6+
ms.author: [your Microsoft alias or a team alias]
7+
ms.service: [the approved service name]
8+
ms.topic: how-to #Don't change
9+
ms.date: [mm/dd/yyyy]
10+
11+
#customer intent: As a <role>, I want <what> so that <why>.
12+
13+
---
14+
15+
<!-- --------------------------------------
16+
17+
- Use this template with pattern instructions for:
18+
19+
How To
20+
21+
- Before you sign off or merge:
22+
23+
Remove all comments except the customer intent.
24+
25+
- Feedback:
26+
27+
https://aka.ms/patterns-feedback
28+
29+
-->
30+
31+
# "[verb] * [noun]"
32+
33+
<!-- Required: Article headline - H1
34+
35+
Identify the product or service and the task the
36+
article describes.
37+
38+
-->
39+
40+
[Introduce and explain the purpose of the article.]
41+
42+
<!-- Required: Introductory paragraphs (no heading)
43+
44+
Write a brief introduction that can help the user
45+
determine whether the article is relevant for them
46+
and to describe the task the article covers.
47+
48+
-->
49+
50+
## Prerequisites
51+
52+
<!-- Optional: Prerequisites - H2
53+
54+
If included, "Prerequisites" must be the first H2 in the article.
55+
56+
List any items that are needed to complete the How To,
57+
such as permissions or software.
58+
59+
If you need to sign in to a portal to complete the How To,
60+
provide instructions and a link.
61+
62+
-->
63+
64+
## "[verb] * [noun]"
65+
66+
[Introduce the procedure.]
67+
68+
1. Procedure step
69+
1. Procedure step
70+
1. Procedure step
71+
72+
<!-- Required: Steps to complete the task - H2
73+
74+
In one or more H2 sections, organize procedures. A section
75+
contains a major grouping of steps that help the user complete
76+
a task.
77+
78+
Begin each section with a brief explanation for context, and
79+
provide an ordered list of steps to complete the procedure.
80+
81+
If it applies, provide sections that describe alternative tasks or
82+
procedures.
83+
84+
-->
85+
86+
## Clean up resources
87+
88+
<!-- Optional: Steps to clean up resources - H2
89+
90+
Provide steps the user can take to clean up resources that
91+
they might no longer need.
92+
93+
-->
94+
95+
## Next step -or- Related content
96+
97+
> [!div class="nextstepaction"]
98+
> [Next sequential article title](link.md)
99+
100+
-or-
101+
102+
* [Related article title](link.md)
103+
* [Related article title](link.md)
104+
* [Related article title](link.md)
105+
106+
<!-- Optional: Next step or Related content - H2
107+
108+
Consider adding one of these H2 sections (not both):
109+
110+
A "Next step" section that uses 1 link in a blue box
111+
to point to a next, consecutive article in a sequence.
112+
113+
-or-
114+
115+
A "Related content" section that lists links to
116+
1 to 3 articles the user might find helpful.
117+
118+
-->
119+
120+
<!--
121+
122+
Remove all comments except the customer intent
123+
before you sign off or merge to the main branch.
124+
125+
-->

‎.github/agents/templates/overview.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: [Follow SEO guidance at
3+
https://review.learn.microsoft.com/en-us/help/platform/seo-meta-title]
4+
description: "[Article description]."
5+
author: [your GitHub alias]
6+
ms.author: [your Microsoft alias or a team alias]
7+
ms.service: [the approved service name]
8+
ms.topic: overview #Don't change
9+
ms.date: [mm/dd/yyyy]
10+
11+
#customer intent: As a <role>, I want <what> so that <why>.
12+
13+
---
14+
15+
<!-- --------------------------------------
16+
17+
- Use this template with pattern instructions for:
18+
19+
Overview
20+
21+
- Before you sign off or merge:
22+
23+
Remove all comments except the customer intent.
24+
25+
- Feedback:
26+
27+
https://aka.ms/patterns-feedback
28+
29+
-->
30+
31+
# What is [product or service]?
32+
33+
<!-- Required: Article headline - H1
34+
35+
Identify the product or service and the feature area
36+
you are providing overview information about.
37+
38+
-->
39+
40+
[Introduce and explain the purpose of the article.]
41+
42+
<!-- Required: Introductory paragraphs (no heading)
43+
44+
Write a brief introduction that can help the user
45+
determine whether the article is relevant for them
46+
and to describe how the article might benefit them.
47+
48+
-->
49+
50+
## [Feature section]
51+
52+
[Introduce a section that describes a feature.]
53+
54+
<!-- Required: Feature sections - H2
55+
56+
In two or more H2 sections, describe key features of
57+
the product or service. Consider sections for basic
58+
requirements, dependencies, limitations, and overhead.
59+
60+
-->
61+
62+
## Related content
63+
64+
- [Related article title](link.md)
65+
- [Related article title](link.md)
66+
- [Related article title](link.md)
67+
68+
<!-- Optional: Related content - H2
69+
70+
Consider including a "Related content" H2 section that
71+
lists links to 1 to 3 articles the user might find helpful.
72+
73+
-->
74+
75+
<!--
76+
77+
Remove all comments except the customer intent
78+
before you sign off or merge to the main branch.
79+
80+
-->

0 commit comments

Comments
 (0)