Skip to content
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

Added initial draft charter. #2

Merged
merged 8 commits into from
Oct 18, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions charter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
The Docs Working Group should exist as a support/helper and advisory group to all the subprojects in Jupyter. Here are some additional details to clarify the WG's scope and role:
ericsnekbytes marked this conversation as resolved.
Show resolved Hide resolved

ericsnekbytes marked this conversation as resolved.
Show resolved Hide resolved
### The WG's scope and role:
ericsnekbytes marked this conversation as resolved.
Show resolved Hide resolved

- Help write docs (inside the bounds of each subproject's governance)
ericsnekbytes marked this conversation as resolved.
Show resolved Hide resolved
- Develop recommendations and guidance:
- For communicating common information and concepts across the Jupyter ecosystem
- 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)
- ...because we want to encourage consistency across the Jupyter ecosystem and between different projects
- Community engagement
- To help connect users with information
- 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 tasks that will be beneficial to docs and support the Docs Working Group's goals (such as writing PRs for unit tests related to documentation code, automations for gathering ReadTheDocs traffic stats, etc.)

One reason for starting the Docs Working Group is to provide a place for consistent, focused effort to be spent specifically on docs across the whole ecosystem.

In other words, the Docs Working 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).

Reflecting on the above, a goal/mission for the group might boil down to:

### Goals/Mission

- Help support and 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
- Engage with the community to help users with Jupyter products, and to get them the information they need