Documentation and Curation issueshttp://opensource.ieee.org/groups/community-advisory-group/documentation-curation/-/issues2022-02-25T19:26:36Zhttp://opensource.ieee.org/community-advisory-group/documentation-curation/meetings/-/issues/4Create a plan for tackling the Community Handbook2022-02-25T19:26:36ZNuritzi SanchezCreate a plan for tackling the Community HandbookHere is a way we might want to split up our work on the Community Handbook Toolkit:
- Components of a handbook
- Writing Style and Guidelines
- Topics covered
- Suggested Tool Stack
- How updates are handled
- Outreach
Here is a [pres...Here is a way we might want to split up our work on the Community Handbook Toolkit:
- Components of a handbook
- Writing Style and Guidelines
- Topics covered
- Suggested Tool Stack
- How updates are handled
- Outreach
Here is a [presentation about community handbooks](https://docs.google.com/presentation/d/1hIWZwZrPp0rSlBnmpXpvSiKsYWKw26PE-SfEeSvzmlk/edit) to help guide us.
**Update: We have begun to work on a community handbook for IEEE SA Open. The first iteration can be found here: [https://opensource.ieee.org/community-handbook](https://opensource.ieee.org/community-handbook).**
# Brainstorm for what to include in a handbook
## IEEE SA Open Community Handbook
Themes we want to explore:
* Create Buy-In
* Tool Stack
* Topics Covered
* Writing Style and Guidelines
* How updates are handled
### Topics We Want to Cover
#### About
* Mission, Vision & Values (inclusivity is part of our values)
* History
* Governance model
* Code of Conduct
* Community Guidelines (not added for now, need to make sure we understand what this would be for)
* How we communicate
* Terminology
* FAQs
#### Community Processes
These are processes that are relevant to the whole community.
* Recommendations for having meetings
* How to use the handbook
* Handbook guidelines (getting started page, contributing authors, etc)
* Writing Style and Guidelines
#### Participating
1. Getting Started
* Different pathways
* Forming a new group
* Stopping a new group
* How to use GitLab
1. Advisory Groups
* Community Advisory Group
* Documentation and Curation
* Community Badging
* Diversity Equity and Inclusion
* Open Community Development Models
* Education
* Technical Advisory Group
* Security
* Data Governance
* Marketing Advisory Group
* Marketing Research and Open Source Intelligence
* Metrics
* How to Market Open Source
* Event Production
1. Hosted Groups/Projects
1. Standards Groups/Projects
1. Path to Leadership (TBD within IEEE SA Open)
#### Social
* How to meet other community members and tools you use to communicate
## Community Handbook Toolkit
This might also be a path to becoming a standard.
#### About
* Mission
* Vision
* Values
* History
* Governance model
* Code of Conduct
* Community Guidelines
* How we communicate
* Terminology
#### Participating
* Path to Leadershiphttp://opensource.ieee.org/community-advisory-group/documentation-curation/meetings/-/issues/6Ideas for Tracking Responsibility & Review Information2021-11-16T21:32:40ZBeth HancockIdeas for Tracking Responsibility & Review InformationAs a portion of Curation, there should be a documentation review process established for many documents that facilitates the proper updating of the document.
Certain tracking information should be stored in an easily accessible file
*...As a portion of Curation, there should be a documentation review process established for many documents that facilitates the proper updating of the document.
Certain tracking information should be stored in an easily accessible file
* Who/what group is responsible for the doc?
* When was the doc last updated/reviewed?
* How often should the doc be reviewed or when is the next revision due?
* What docs are associated with this doc and may need to be updated?http://opensource.ieee.org/community-advisory-group/documentation-curation/about/-/issues/9Tooling Comparison Table2021-11-10T22:19:42ZBeth HancockTooling Comparison TableThis will help us evaluate possible tools for creating a community handbook.
In order to evaluate this, we want to first create a snapshot view.
Here are the factors we'd add in the snapshot view:
1. Name
2. Examples?
3. OSS or P...This will help us evaluate possible tools for creating a community handbook.
In order to evaluate this, we want to first create a snapshot view.
Here are the factors we'd add in the snapshot view:
1. Name
2. Examples?
3. OSS or Proprietary?
4. Cost
5. Version Control
6. Usability (1-5)
7. Vibrant community (1-5)
8. [Accessibility]( https://opensource.ieee.org/community-advisory-group/documentation-curation/about/-/blob/main/Supporting%20Documentation/WCAG2.1_Checklist_Template.ods )
9. Ease of visual formatting?
We would evaluate a list of tools with the snapshot model (a table created from the factors above). Then we would evaluate 2-3 of the tools that are our front-runners using the [project maturity model](https://opensource.ieee.org/technical-advisory-group/draft-project-maturity-model).
We may need to expand on some of the later factors in the snapshot view above. We could copy the finalized project maturity model and expand upon it for those factors. The snapshot would then include a score and link to more detail in the evaluation.
#### Visual Formatting
* What kind of image files are supported?
* File storage?
* Headers and general formatting
* How easy to insert an image?
* How easy to insert video?
* What kind of image files are supported?
#### Cost
* subscription cost
* hosting & maintenance
* storagehttp://opensource.ieee.org/community-advisory-group/documentation-curation/about/-/issues/10Create process to gather community reviews of community handbook tools2021-11-10T22:13:41ZBeth HancockCreate process to gather community reviews of community handbook toolsWe would ask people to review tools using these frameworks and submit those for others to access.We would ask people to review tools using these frameworks and submit those for others to access.http://opensource.ieee.org/community-advisory-group/documentation-curation/about/-/issues/8Possible Community handbook tools2021-11-10T21:46:07ZBeth HancockPossible Community handbook toolsWe're gathering possible tools for community handbooks. We would appreciate any further suggestions. Please add them as comments!
* [Almanac](https://almanac.io/ )
* [GitBook](https://docs.gitbook.com/ )
* [Hugo Pages](https://gohug...We're gathering possible tools for community handbooks. We would appreciate any further suggestions. Please add them as comments!
* [Almanac](https://almanac.io/ )
* [GitBook](https://docs.gitbook.com/ )
* [Hugo Pages](https://gohugo.io/variables/page/ )
* [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/ )
* [GitHub Pages](https://pages.github.com/ )
* [Notion](https://www.notion.so/ )http://opensource.ieee.org/community-advisory-group/documentation-curation/about/-/issues/4Change default group sort order2021-08-17T17:50:04ZBeth HancockChange default group sort orderCheck to see if [changing default group sort order]( https://gitlab.com/gitlab-org/gitlab/-/issues/26287 ) is something that can be done in Community Edition. The linked issue began about project sort order, but also discusses group sort...Check to see if [changing default group sort order]( https://gitlab.com/gitlab-org/gitlab/-/issues/26287 ) is something that can be done in Community Edition. The linked issue began about project sort order, but also discusses group sort order.Nuritzi SanchezNuritzi Sanchezhttp://opensource.ieee.org/community-advisory-group/documentation-curation/meetings/-/issues/3Docs & Curation elevator pitch2021-07-20T16:34:57ZKarsten WadeDocs & Curation elevator pitch
**Estimated time:**
4 hours
**Description:**
We could have a short description (elevator pitch) of what this sub-group is trying to accomplish for the IEEE SA OPEN platform to get other members curious and excited about what is coming.
**Estimated time:**
4 hours
**Description:**
We could have a short description (elevator pitch) of what this sub-group is trying to accomplish for the IEEE SA OPEN platform to get other members curious and excited about what is coming.Karsten WadeKarsten Wadehttp://opensource.ieee.org/community-advisory-group/documentation-curation/meetings/-/issues/2Define Purpose for Documentation and Curation2021-07-20T16:34:42ZBeth HancockDefine Purpose for Documentation and Curationhttp://opensource.ieee.org/community-advisory-group/documentation-curation/documents-to-create/-/issues/1Team Agreement Template2021-06-22T20:38:23ZBeth HancockTeam Agreement Template1. We start on time and end on time; anyone is welcome to join as they are able.
2. We will respect everyone's time. <br>
3. Our meetings are scheduled for fifty minutes to allow for transition time between meetings. <br>
4. Participa...1. We start on time and end on time; anyone is welcome to join as they are able.
2. We will respect everyone's time. <br>
3. Our meetings are scheduled for fifty minutes to allow for transition time between meetings. <br>
4. Participation is encouraged - Be Awkward! We will encourage questions.
5. Another way to participate is to write in public chat, in addition to speaking. <br>
6. It's ok to be quiet and think about what's happening. We do not pressure people to speak during our meetings.<br>
7. Video is optional. <br>
8. We will encourage multiple perspectives on issues and treat them objectively. <br>
9. We strive to keep the conversation on track to respect one another's time. We are grateful to our facilitators for helping us be aware. <br>
10. Open debate and disagreement are encouraged in our meetings, but once a decision is made all members of the team agree to commit to and support that decision, or at a minimum, avoid actions that could be construed as undermining, or impeding execution of a decision. <br>
11. We will make important decisions asynchronously as a community.<br>
12. Decisions must be transparent, agreed to in written form, and made in an archived communication channel. <br>
13. Decisions are never finalized during meetings because not everyone can attend; meetings result in suggestions.<br>
14. We value everyone's opinion.<br>
15. We will honor our commitments. If we are unable to complete a task, we will bring this up to the team so that someone else can step in and help. We are all volunteers with other commitments and we do our best to support each other in this community endeavor. <br>
16. We will record all meetings for those who cannot attend.<br>
17. We will help our team members be successful.<br>
18. We will assume positive intent by team members.<br>
19. All processes and documentation are works in progress and can be changed.<br>http://opensource.ieee.org/community-advisory-group/documentation-curation/documents-to-create/-/issues/2Doc and Cur Roles and Responsibilities2021-05-26T16:07:19ZBeth HancockDoc and Cur Roles and ResponsibilitiesWhen creating the team agreement, we discussed some things about the role of the facilitator. Do we want to outline a roles and responsibilities document?
* The facilitator's tasks include keeping the conversation on track. When creating the team agreement, we discussed some things about the role of the facilitator. Do we want to outline a roles and responsibilities document?
* The facilitator's tasks include keeping the conversation on track. http://opensource.ieee.org/community-advisory-group/documentation-curation/community-handbook-toolkit/-/issues/2MozFest Presentation Links2021-04-22T22:09:24ZBeth HancockMozFest Presentation Links[MozFest workshop description](https://pretalx.com/mozfest-2021/talk/VCEU3Y/)
- Recorded workshop at MozFest:
- [Slides from MozFest](https://pretalx.com/media/mozfest-2021/submissions/VCEU3Y/resources/Mozfest_2021__Community_...[MozFest workshop description](https://pretalx.com/mozfest-2021/talk/VCEU3Y/)
- Recorded workshop at MozFest:
- [Slides from MozFest](https://pretalx.com/media/mozfest-2021/submissions/VCEU3Y/resources/Mozfest_2021__Community_Handbook_Best_Practice_CRL1E19.pdf)
- [Notes via Silona of the Miro board from MozFest](https://docs.google.com/document/d/18lvRkWYRIsQY2vOiOl9lrke6oPobQP6a3-N6eSEqe3U/edit#)
- [Miro board from the session](https://miro.com/app/board/o9J_lRx-v9c=/)
@juskirat2000 @nuritzis Do either of you have a link to the recorded workshop?http://opensource.ieee.org/community-advisory-group/documentation-curation/community-handbook-toolkit/-/issues/1Source Material2021-04-08T19:20:05ZBeth HancockSource MaterialPossible documents to pull from or include in the Community Handbook Toolkit.
@nuritzis @juskirat2000 @nihal.parekh @quaidPossible documents to pull from or include in the Community Handbook Toolkit.
@nuritzis @juskirat2000 @nihal.parekh @quaid