- See BP Docs re-reboot launch
- In attendance: @dcavins @im4th @emaralive
- Slack archive
What about the BP Docs team?
Some facts:
- @emaralive informed the g-spreadsheet the BP Docs team leader shared to manage & track BP Codex content migration tasks had vanished 😓.
- @im4th informed he had no replies to the meeting invite he sent to the 2 members of the BP Docs team on January 2, 2024 🗣️ but he was hoping they might join the docs-chat soon.
- Members of the BP Docs team never showed up: there’s no more BP Docs team 🪦.
Let’s move on and focus on the most important: Migrating & Maintaining BuddyPress documentation content with the tools we have (the BuddyPress GitHub organization’s ones).
@im4th suggested not to try building another Docs team and to contribute to documentation content just like we would for BuddyPress code. @dcavins agreed confirming “any team shouldn’t be separate, because documentations are so critical to the continued success of BuddyPress“.
Let’s reorganize!
Another lesson learned from the BP Docs team experience is: the tool to manage & track Documentation tasks needs to be secured and always available to the BuddyPress project. Hosting a file on one of our personal drive/tool is too risky (@im4th lost some notes/comments he added to the vanished g-spreadsheet 😫).
- We decided to create a new GitHub repository: bp-documentation, to use issues as Documentation tasks and to regularly update a GitHub project to track our progress.
- @im4th suggested we could take turns leading the docs-chats, he then volunteered to generate a list of issues out of BP Codex pages to migrate, and shared a link to the Documentation resource explaining how to contribute to Documentation content.
- @dcavins shared his favorite Markdown editor: MacDown, @im4th likes to use VS Code, @emaralive said there was a lot of tools available to edit Markdown: even Google Docs with a specific extension can be used to generate it.
- @im4th recommended we add a specific note to BP Codex pages once they have been migrated, here’s an example of it.
- Let’s get our hands dirty!
Using our new BP Documentation tracker
After the meeting, @im4th created the bp-documentation repository and started exploring a way to batch create issues. As it seems to require some specific scripts to loop into a flat file and to use the GitHub API, he chose a workaround (even if it will take us more time as we’ll need to manually create the GH issues out of this list of BP Codex pages). He created 3 Documentation tasks using the GitHub Issue Template feature:
Each issue has a create form which includes some fields to qualify/explain the issue (eg: what, how, where) and a checklist of tasks to perform once it is submitted. The first of these being setting the Documentation project status to “Todo”.
This should help us to collaborate & track our progress about migrating the existing BP Codex page or ignoring some of them. Repository main’s README is detailing how to get started! If you have questions about it before our next meeting, don’t hesitate to comment this post or ping me on Slack. Finally here’s a screenshot of the Project view:
NB: @dcavins & @emaralive you’ll need to clone the repository to add one of these marks to the list of BP Codex pages to avoid creating duplicate issues 😅:
- ♻️ Migrate issue/task created.
- 🛑 Ignore issue/task created.
PS: don’t forget to commit and push these changes 👏.
Next Docs-Chat
It will happen on January 24, 2024 at 19:00 UTC in #BuddyPress.
🪂 📚
