Skip to content

Commit 1f719bc

Browse files
committed
Even shorter and to the point Setup phase added
1 parent 3008746 commit 1f719bc

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,38 @@
33
## How to use this template for documenting your OS2 project
44

55
## 👷 Maintainers guide
6+
67
*In OS2 projects the maintainer team is the group of individuals assigned to oversee the development, quality, and community engagement of the documentation project.*
78

9+
#### Setup
810

911
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.
1018

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)
1320
- [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.
1421
- [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.
1522
- 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.
1623

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,
2325

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)
2431
2532
## 🧑‍🦰 Contributors Guide
33+
2634
*Contributors to the documentation can be project managers, technical editors, developers and end-users.*
2735

2836
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-
3037
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-
3238
3. Collaborate on documentation branches with issues assigned to you by the maintainers.
3339

3440
[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
4349
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.
4450

4551
## Contributing
52+
4653
Feel free to contribute, suggest an issue or submit a pull request with your improvements to this template.
4754

4855
## Licensing and Attribution

0 commit comments

Comments
 (0)