-
Notifications
You must be signed in to change notification settings - Fork 89
Initial Documentation working group charter #198
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
fd72bf2
edaf7d6
a034362
74e87a0
3cfe9ea
6636f95
429d5e9
09bd4d0
54e4099
ef93af2
aaf0076
0adb09e
5771bb1
d3869c0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Docs Working Group Charter (Proposed) | ||
|
|
||
| ## Mission and Goals | ||
|
|
||
| The Docs Working Group serves as a support, helper, and advisory body to Jupyter subprojects on all aspects of documentation. The core pillars of our mission: | ||
RRosio marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - Improve all aspects of documentation across the Jupyter ecosystem | ||
| - Make high quality documentation that is clear, comprehensive, inclusive, and serves the varying needs of Jupyter's diverse community | ||
RRosio marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Engage with the community to help users with Jupyter products, discover their needs, and connect them with relevant information, expertise and resources | ||
|
|
||
| The Docs Working Group will provide a place for consistent, focused, holistic efforts to be spent on docs across the whole ecosystem. This group exists in part to provide capacity and resources to the subprojects (some of which are already suffering from a lack of resources/capacity, and more specifically to work on docs in particular). | ||
|
|
||
| We want all users to have positive experiences inside the Jupyter ecosystem, especially users who are learning and coming in for the first time, and users with disabilities. | ||
|
|
||
| ## The Docs Working Group's Activities | ||
|
||
|
|
||
| The Docs Working Group will focus on the efforts described below, in service of its mission: | ||
|
|
||
| - Help write docs (inside the bounds of each subproject's governance) | ||
RRosio marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - This includes meta docs, cross-cutting docs (items relevant to multiple subprojects), developer and contributor docs, non user-facing docs and others | ||
RRosio marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Develop recommendations and guidance: | ||
| - For communicating common information and concepts across the Jupyter ecosystem | ||
| - Because we want to encourage consistency across the Jupyter ecosystem and between different projects | ||
| - For style and best practices when authoring documentation media | ||
| - Including technical advice, such as tools-usage and markdown guidance that helps support high level goals, like interlinking/cross-connection between subprojects | ||
| - Community engagement | ||
| - To help connect users with information, expertise and resources | ||
RRosio marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - To gather feedback from the community about what needs to be documented/what information they need | ||
| - Help support and improve all aspects of documentation across the Jupyter ecosystem | ||
| - This means, for members of the group, also taking on any related (non-document) tasks that will be beneficial to docs and support the Docs Working Group's goals, such as: | ||
| - Developing application extensions related to docs, like in-app integrated docs, guided in-application tours or hoverable "what's this" features | ||
| - Automations for gathering ReadTheDocs traffic stats to gauge user interest | ||
|
||
| - Creating pip installable packages for getting offline docs | ||
| - Writing PRs for unit tests related to documentation code | ||
| - Automated discourse or CI bots for gathering user feedback from community sites | ||
| - Adding a new embedded "Hot Topics" feature on ReadTheDocs FAQ pages to automated discourse community discussion aggregator | ||
|
||
| - Any other innovations or work that may improve Jovyans' experience in/understanding of the Jupyter ecosystem | ||
|
|
||
| ## Founding Members | ||
|
|
||
| - Carlos Brandt | ||
| - Carol Willing | ||
| - Eric Gentry | ||
| - Frederic Collonval | ||
| - Mike Krassowski | ||
RRosio marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Nick Bollweg | ||
| - Paul Ivanov | ||
| - Rosio Reyes | ||
|
|
||
| ## Decision Making | ||
|
|
||
| The Docs Working Group will establish a council (by Jupyter convention) to make decisions. | ||
|
|
||
| The Docs Working Group Council will initially be made up of the founding members. Council members can then initiate a vote to add new members (or remove members by a two thirds majority with a quorum of two thirds of all council members). The voting process will follow the guidelines established in the [Jupyter Governance Decision Making document](https://jupyter.org/governance/decision_making.html). | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the Jupyter ecosystem, the term "doc" has a number of different meanings (notebook docs, documentation, etc.). It may be helpful to spell out "Documentation" in the charter to clarify this to people who may not have full context.