Today we had the first meeting of the Pods Doc Team. We had five community volunteers along with myself, and our lead developer Scott. During this basic planning meeting we introduced ourselves, went over goals for the group and brainstormed topics to cover for future #podsdocthursday events. Before our next meeting, which will be held at 11AM EDT/ 1500 UTC, on Friday January 31st, we will be organizing around the various topics we decided on at the meeting.
A full transcript of the meeting can be found here.
Pods Doc Team Trello Board and Doc Team User Role
The Pods Doc Team is organized via a Trello Board. Anyone who would like to be involved and has not yet been added to the board should email me and I will add you right away. On the board are links to pages about submitting tutorials to Pods.io, which is possible for anyone who has the “Doc Team” user role, as well as links to inline documentation standards. This user role allows team members to add tutorials, either the complete text or links to tutorials on their own site, to Pods.io. There is also a discussion list for general discussions.
#PodsDocThursday Topics
We brainstormed three topics for #PodsDocThursday “Customizing The Admin UI,” “WordPress Themeing With Pods” and “Creating User, Employee and Organization Directories.” Each one now has its own list on the Pods Doc Team Trello board. Everyone is encouraged to discuss tutorial topic ideas, as well as link to relevant example code and list related actions in filters on the relevant cards. If you would like to write a specific tutorial, please create a card on the list explaining the tutorial and assign yourself.
It is important to keep in mind that writing tutorials or inline docs is not the only way to contribute. Contributing code examples to build tutorials around or to be added to our documentation pages is a very valuable contribution that you can make. If you have any relevant code for any topic, please leave a link to a gist or pastebin on the appropriate card.
Inline Docs
Pods has hundreds of filters and actions that are in need of docs. For this reason prioritizing our work to add inline docs is very important. For this reason we will focus on adding inline docs for filters and actions relevant to each #PodsDocThursday topic. In addition, I have stated a card in Trello to list priority filters and actions. Please add filters and actions that are, in your opinion priorities for documenting.
Inline doc standards can be found here. I will be updating that page with how to add example code, which will also apply to function documentation, soon.
Preliminary Agenda For Meeting #2
- Example Code- What’s the best way to organize it?
- Open Discussion- How could Pods documentation be better for both novice and advanced users.
- Reviewing topics for #PodsDocThursday
- Starting a calendar For #PodsDocThursday
- Priorities For Inline Docs
The next meeting will be held at 11AM EDT/ 1500 UTC, on Friday January 31st