Skip to content

Commit 893e0e3

Browse files
Add projects folder and template (#8527)
Co-authored-by: otelbot <[email protected]>
1 parent e9d6e35 commit 893e0e3

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

projects/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This folder contains SIG Comms projects related to OpenTelemetry documentation
2+
improvements. Each project file documents a specific initiative.
3+
4+
To create a new project file, use `_TEMPLATE.md` as a starting point. Copy the
5+
template and fill in the relevant sections with your project details.

projects/_TEMPLATE.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Project title
2+
3+
## Description
4+
5+
<!-- Provide a comprehensive description of the project, including its purpose, scope, and context. You may include example use cases, background information, or any other relevant details that help readers understand what the project is about. -->
6+
7+
### Current challenges
8+
9+
<!-- Describe the current challenges or problems that this project aims to address. Explain why this project is needed and what gaps it fills. -->
10+
11+
### Goals, objectives, and requirements
12+
13+
<!-- Clearly state the goals, objectives, and requirements of the project. Explain what the project intends to achieve and any specific requirements or constraints that need to be considered. -->
14+
15+
## Deliverables
16+
17+
<!-- List the deliverables for the project. You may organize them by timeframes (e.g., immediate term, middle term, long term) or by categories. Be specific about what will be produced or achieved. -->
18+
19+
## Staffing / Help Wanted
20+
21+
<!-- Provide information about the project team, including project leads, sponsoring members, and engineers. You may include a table with columns for alias, language, company/project, and time commitment. Also indicate if you're looking for more contributors. -->
22+
23+
## Meeting Times
24+
25+
<!-- Specify the meeting schedule for the project, including frequency, day of week, and time (with timezone). -->
26+
27+
### Meeting Links
28+
29+
<!-- Provide links to meeting resources such as calendar invites, meeting notes, or other relevant documentation. -->
30+
31+
## Discussion
32+
33+
<!-- List communication channels for project discussions, such as Slack channels, mailing lists, or other forums. -->
34+
35+
## Timeline
36+
37+
<!-- Provide a timeline or roadmap for the project, including key milestones and target dates. You may organize this as a list or in another format that clearly shows the project schedule. -->
38+
39+
## Labels
40+
41+
<!-- List any GitHub labels or tags that should be associated with this project. -->
42+
43+
## Linked Issues and PRs
44+
45+
<!-- Provide links to related GitHub issues and pull requests that are relevant to this project. Format as a list with descriptive text and links. -->
46+
47+
## Project Board
48+
49+
<!-- Provide a link to the project board or kanban board if one exists for tracking project progress. -->

0 commit comments

Comments
 (0)