2024-07-24 Documentation WG Meeting notes
- Marco Morales
- Glib Glugovskiy
All public Working Group meetings follow the Recording Policy for Open edX Meetings
Date
Jul 24, 2024
Participants
@Marco Morales (Schema)
@Michelle Philbrick (Axim)
@Glib Glugovskiy (Raccoon Gang)
@Maria Fernanda Magallanes Z (Edunext)
Deimer Morales (Edunext)
@Chintan Joshi (iLearn)
@Ghassan Maslamani
Goals
Initial meeting, gathering topics for exploration, working group formation
Discussion topics
Time | Item | Presenter | Notes |
|---|---|---|---|
7-7:13am PT | Introductions |
| |
7:13-7:18 | Charter Doc Review |
| |
| Topic: Github Resources |
| Quick review / exploration: https://github.com/orgs/openedx/projects/32 closed- https://github.com/orgs/openedx/projects/22 Documentators notes / processes - https://docs.openedx.org/en/latest/documentors/index.html |
7:24 | Platform 30 Second How To’s | @Michelle Philbrick | Could these be in scope for this group? To help new platform adopters / users? To highlight recent changes, etc? @Michelle Philbrick volunteered to help test out ‘finding documentation / resources' to help understand what new platform users might have a hard time learning |
7:25 | Comfort writing RST | @Ghassan Maslamani | Is this comfortable / easy to do this? Markdown may be easier broadly, but the writing format might be helpful to bring up for future discussion. Online converters exist to make drafting these easier. |
7:29 | How to Articles to help set up documentation | Deimer | Explanation / how to videos for how to start guides for documentation articles. How to we structure documentation to help support discovery / finding them. |
| Documentation Types | @Glib Glugovskiy | Long term - committed into code Customer facing / wiki pages / slack / discuss Which types of documentation are in focus for this group? Long term? indexed? others? |
7:39 | Platform Structure / Naming Consistency | @Marco Morales | Organization of platform / shared hierarchy / structure for how to organize docs for discovey Discussed use of a glossary -https://docs.openedx.org/en/latest/developers/references/glossary.html
|
7:41 | Meeting Cadence / Structure |
| Meeting every two weeks, use Slack #documentation for ongoing conversation We can try the same time in 2 weeks? We set up recurring weekly wednesday 10am ET meetings to start on 2nd and 4th wednesdays of the month, will get feedback on how to shift 1 or both of these recurring meetings in Slack |