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

Open edX Handbook #128

Open
cassiezamparini opened this issue Oct 16, 2024 · 8 comments
Open

Open edX Handbook #128

cassiezamparini opened this issue Oct 16, 2024 · 8 comments
Assignees

Comments

@cassiezamparini
Copy link

cassiezamparini commented Oct 16, 2024

Proposal

See proposal

Phase 1 Schedule

1: Define the New Handbook Structure

  • Assignees: @cassiezamparini and @jalondonot
  • Task: Analyze survey feedback and existing Core Contributor information to outline the essential sections of the Handbook.
  • Timeline: 13 - 24 January 2025

2: Get Feedback on New Handbook Structure

  • Assignees: @cassiezamparini, @jalondonot and wider community.
  • Task: Validate the proposed list of sections with reviewers, and establish the priority order for section development.
  • Timeline: 27 January - 9 February 2025

3: Incorporate Feedback into the New Handbook Structure

4: Create a Space for the Handbook in the Open edX Docs

  • Assignees: @cassiezamparini and TBD
  • Tasks:
    • Set Up a GitHub Repository for Handbook for facilitating easy submission of changes. (See how this page in the "Docs" explains how to update documentation. This is a nice resource to include)
    • Create a section in the Open edX docs.
  • Timeline: TBD

Phase 2 Schedule

The phase 2 timelines will be fleshed out once Phase 1 is completed.

1: Iterative Content Development and Population

  • Developed in 4-week intervals
    • Weeks 1-2: Develop content for the highest-priority sections with the help of Core Contributor volunteers.
    • Weeks 3-4: Review and refine these sections based on feedback and publish the content.

2: Repeat Development Cycles:

  • Continue developing and refining additional sections in 4-week intervals, incorporating feedback and making iterative improvements as needed.
@antoviaque
Copy link

@cassiezamparini During the last meeting of the coordination working group, we set as a goal to have a plan for each of the approved proposals from the summit. It's likely going to be tricky to get things done with Christmas, but what would be your plan & timeline beyond that?

@cassiezamparini
Copy link
Author

@antoviaque I will only be able to start tackling this in January 2025. My aim is to post a plan then :)

@cassiezamparini
Copy link
Author

cassiezamparini commented Jan 7, 2025

@antoviaque and @jalondonot I've added a schedule at the top of this page.


@openedx/ccp-committer-jswope00 One thing I will need technical help with is this item:

Create a Space for the Handbook in the Open edX Docs

Tasks:

  1. Set Up a GitHub Repository for Handbook for facilitating easy submission of changes or will we leverage the Docs repository? See my note below though on having a project board dedicated to the Handbook.
  2. Create a Handbook section in the Open edX docs

Would you be able to assist me? Or suggest someone else that could help?


Since the Handbook will / might have its own repository, it can also have its own project board. This will allow us to manage multiple content creation tasks concurrently.

I know we agreed to use the CC Topics board for all Summit tasks @antoviaque, but I think the Handbook is a different case, as it will be an ongoing project. So that's why I’d prefer to manage the Handbook content tasks on their own board.

@openedx/ccp-committer-jswope00, how do you currently manage the Docs tasks?

@antoviaque
Copy link

@cassiezamparini Thanks! The timeline looks good 👍

I know we agreed to use the CC Topics board for all Summit tasks @antoviaque, but I think the Handbook is a different case, as it will be an ongoing project. So that's why I’d prefer to manage the Handbook content tasks on their own board.

No worries at all - we can organize the boards as is the most convenient, especially for the people who will be using them the most, ie likely you :)

@cassiezamparini
Copy link
Author

Thanks @antoviaque

@sarina @feanil @mphilbrick211 Let me know if you have any thoughts on the below from an Axim perspective:


One thing I will need technical help with is this item: Creating a Space for the Handbook in the Open edX Docs which will mean setting up a GitHub Repository for Handbook for facilitating easy submission of changes / leveraging the current Docs repository? I'd love everyone's thoughts on this and any colunteers to help (I've pinged @openedx/ccp-committer-jswope00 too).

Ideally I'd also like the Handbook to have it's own project board to handle the content creation aspect.

@antoviaque Feel free to add any comments about this too...

@sarina
Copy link
Contributor

sarina commented Jan 8, 2025

We'd prefer to not create new repositories if possible. Would it work to create space on docs.openedx.org?

@cassiezamparini
Copy link
Author

@sarina I'm happy with that. As long as it's cool if the Handbook has it's own project board?

Who would be best to help me set it up / get the lay of the repository land (this is new territory for me!)? Alternatively I can ask one of our in-house CC's to assist?

@sarina
Copy link
Contributor

sarina commented Jan 9, 2025 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Enhancement of CC Experience
Development

No branches or pull requests

3 participants