You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-10Lines changed: 17 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -3,32 +3,38 @@
3
3
## How to use this template for documenting your OS2 project
4
4
5
5
## 👷 Maintainers guide
6
+
6
7
*In OS2 projects the maintainer team is the group of individuals assigned to oversee the development, quality, and community engagement of the documentation project.*
7
8
9
+
#### Setup
8
10
9
11
1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch.
12
+
3. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). The documentation site is now live!
13
+
4. Edit and create `.md`[Markdown files](https://guides.github.com/features/mastering-markdown/) to add more content pages to your docs.
14
+
15
+
#### Maintenance
16
+
17
+
1. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements.
10
18
11
-
2. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements.
12
-
- Organize your work in [Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones)
19
+
- Organize your work in [Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones)
13
20
-[Use task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) to break down larger documentation work into manageble pieces.
14
21
-[Assign labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) to prioritize and classify your issues and maintain an overview on what needs to be done.
15
22
- Document suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
16
23
17
-
3. Stay on top of proposed changes to the documentation by [reviewing and merging Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) to your documentation repository,
18
-
19
-
20
-
> [!TIP]
21
-
>###### In doubt or stuck with a maintainer task?
22
-
>###### Try [these Best Practice advice for maintaining collaborative, safe, and effective communities.](https://docs.github.com/en/communities)
24
+
2. Stay on top of proposed changes to the documentation by [reviewing and merging Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) to your documentation repository,
23
25
26
+
> [!TIP]
27
+
>
28
+
> ###### In doubt or stuck with a maintainer task?
29
+
>
30
+
> ###### Try [these Best Practice advice for maintaining collaborative, safe, and effective communities.](https://docs.github.com/en/communities)
24
31
25
32
## 🧑🦰 Contributors Guide
33
+
26
34
*Contributors to the documentation can be project managers, technical editors, developers and end-users.*
27
35
28
36
1. Document suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
29
-
30
37
2. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
31
-
32
38
3. Collaborate on documentation branches with issues assigned to you by the maintainers.
33
39
34
40
[Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
@@ -43,6 +49,7 @@ Documentation in OS2 products must follow the documentation criteria from the [S
43
49
Following these criteria not only opens up our codebase and fosters collaboration and transparency, but also encourages more organizations to use and adapt our open source products.
44
50
45
51
## Contributing
52
+
46
53
Feel free to contribute, suggest an issue or submit a pull request with your improvements to this template.
0 commit comments