Who writes, uses, and updates the docs? What do sustainable-first docs look like? How can we write better ones?
Bottom liner: Chris Chinchilla, @pia
Issues & Pull Requests: Add docs group #251
Who writes, uses, and updates the docs? What do sustainable-first docs look like? How can we write better ones?
Bottom liner: Chris Chinchilla, @pia
Issues & Pull Requests: Add docs group #251
I donāt see traction here yet but Iām interested and enthusiastic. I know a few different corners of the open source world I might be able to rope into this conversation, but I do not have bandwidth to be a bottom liner or lead this group.
Sorry @jwf I didnāt even know this forum existed, there is some slow traction.
First tell any projects looking for help to sign up for an office hours session.
Next steps are also to compile resources, there are already a lot of these around, so I donāt really want to replicate them, more offer more specific advice and compile that for people to see, which I think might be more useful.
Things that would be nice:
Office hours concept:
Sustainability:
Dimensions on sustainability
Moved the session notes into the repo!
I am interested in working on and collaborating on best practice templates and tools for documentation writers. For example, I have a Sphinx-docs template repository with Travis CI, ReadTheDocs publishing, and more out of the box. It would be nice to collaborate on these kinds of projects (for me) with other folks.
This is one of my personal interests in this working group.
Good call. I actually have a few of these two scattered about the interweb, so would be good to find them a home. I am however, not sure if that would be in the Sustain organisation, or somewhere else, but at the very least, itās a pace to list those available.
Chris has uploaded his rough draft of the manual to the repo. If anyone wants to take a look at it before next Monday, itās available here: https://github.com/sustainers/docs
Good starting point.
I particularly like the Documentation Structure page, which I think is core. Also, I guess it is somewhat the scaffolding of issue 3 and issue 4. If needed, I can help to advance those issues.
Hi all, thought I would follow up and share my own update. The working group met on Monday, 18 May. In attendance we had @ChrisChinchilla, @jlcanovas, @Erioldoesdesign, @esperluette, @RichardLitt, and @jdorfman (hope I didnāt forget anyone!). Here are the notes from our shared HackMD pad:
hi folks! I shared with the Good Docs Project in this weekās meeting (3 June) and linked them to this doc.
Thanks, Erin!
Chris and JWF: How did reaching out go?
@Erioldoesdesign, did you mean the Sustain group in that comment?
Do you mean:
@Erioldoesdesign: Bring up docs with the Sustain design community
Yes I brought this up with the design & ux sustain oss WG we spoke about it last meeting and notes were taken
I did a signal boost on the Fedora Documentation mailing list and added some of our working group meetings to the Fedora Docs scheduling calendar. Doesnāt seem like there were a lot of bites just yet, but I think it might help to narrow down our possible paths forward to make it easier for folks to climb on to these discussions.
Is there a WG for docs meeting today? I have a placeholder in my calendar for 4pm UK time
There should be. Iām double checking with @ChrisChinchilla. I wonāt be able to make it due to a conflict, unfortunately.
I also have it on my calendar, but I have a one-time conflict today and wonāt be able to join either.
There is indeed, but it will be a slim meeting I think. Iāll still run it though, as I have things I want to report on, and move on with.
Ah I donāt have the call joining instructions If I could get them thatād be lovely @ChrisChinchilla
@esperluette The project I mentioned that I use as an example of āminimum indication of welcoming design contributionā is: https://github.com/pa11y/pa11y
https://pa11y.org/contributing/designers/
Specifically this statement: āPa11y hasnāt had loads of attention in this area and weād love you to join us. Itās time to bring some thought and consistency to our project designsā
We also discussed design + docs in the last sustaining Design & UX WG: Design & UX working group