#22 [Proposal] Fedora classroom session: Docs writing 101
Opened a year ago by ankursinha. Modified 5 days ago

Hiya!

We're looking to schedule new classroom sessions. Would someone from docs have the time to take a classroom session on writing documentation for the new docs.fp.o site? There seem to be lots that needs moving and a classroom session would really help folks get started (and hopefully recruit new contributors too). We're also asking attendees to fill out a short survey for each session, and that could be used to get some more information about docs too.

CC'd classroom sessoin wranglers: @skamath @coremodule @siddharthvipul1


Although I'm not a technical writer, I'd be happy to do a classroom covering the technical part. I'm one of the people working on the new docs.fp.o site.

Thanks @asamalik---that'd be great!

Would you want to do it before flock? That way folks planning to attend the docs hackathon at Flock could also be encouraged to attend it. We have a classroom session planned for this week, but nothing after that yet.

The logs from the session would be quite useful as a base for the "How to write docs" article commops is looking into too.

I think it would definitely make sense to do it before Flock.

My goal is to have the new site out before Flock, so it would be ideal to do this after the site is ready, but before Flock. It'll require some planning. I don't think I'm able to give you a date, yet, but let me think about it/talk with others, and I'll let you know!

cc @bex

@ankursinha So it looks like the new Antora-powered site is going live on Wednesday 1 August. If we wanna do this before flock, I would propose either Friday 3 August or Monday 6 August. What do you think?

Hiya! Sorry---I've been away on a "work vacation".

Either date works. Should we do 6th? It'll give us some time to write the magazine post and publicise it?

@ankursinha No worries, hope you've enjoyed it!

Agree, let's do 6th.

Awesome! I'll update the schedule etc. Could you give us a short summary of the session to use for the magazine post? Also, please pick a time for the session, and assuming you'll use blueJeans, could you create a session link thing?

We've started doing short feedback surves for the sessions---would you like me to set up one for this one too?

There's a magazine post on the docs site launch ready to publish. If we can fix a time and a session link before it goes out, we can add this information to the post itself.

@asamalik @bex : we've cloned the previous survey we'd used here: https://goo.gl/forms/IsYmJpC5wZxJKieV2

@giardia has volunteered to help with the survey and the classroom session in general. Thanks @giardia!

We'd opened the survey when the classroom session had started and provided the attendees with the link towards the end, and we'd closed the survey 24 hours after the session.

Edit: removed link that gives edit access (e-mailed it privately)

What about Monday 2 PM UTC?

Description:

"Come and learn how to contribute to Fedora Docs! We'll cover the most frequent workflows such as editing an existing page, adding new ones, or even adding whole new section to the docs. I'll also walk you through the basics of asciidoc, Antora, and git."

BlueJeans URL: https://bluejeans.com/779464241

@ankursinha the google form says "This form is now closed." and won't let me see it :(

Oh! Sorry about that! I've e-mailed you the edit link.

@giardia shall update fedocal and the classroom wiki page, and then we'll go ahead and publicise it on $social media :)

fedocal and classroom wiki page updated. i will wait to add survey link in case you want to add more questions, and i will add magazine link when the post comes out. @ankursinha please check if everything ok :)

@giardia: looks good! Could you edit the event in fedocal and also add the summary and bluejeans link to the description there (for those that only subscribe to the ical feed).

The magazine post is here: https://fedoramagazine.org/fedora-docs-overhaul/ (it mentions the classroom session too).

Done! (testing the reply from mail feature)

Il ven 3 ago 2018 17:11 Ankur Sinha pagure@pagure.io ha scritto:

ankursinha added a new comment to an issue you are following:
``
@giardia: looks good! Could you edit the event in fedocal and also add the
summary and bluejeans link to the description there (for those that only
subscribe to the ical feed).

The magazine post is here:
https://fedoramagazine.org/fedora-docs-overhaul/ (it mentions the
classroom session too).
``

To reply, visit the link below or just reply to this email
https://pagure.io/fedora-docs/issue/22

@asamalik - when you have a few cycles to spare, could you please give us the links to the recording and any additional material/slides? (And then we can close this ticket!)

@ankursinha I've just finished editing the video and will coordinate with @x3mboy on publishing it on the Fedora YouTube channel.

Slides: https://asamalik.fedorapeople.org/slides/2018-08-fedora-docs-classroom/FedoraClassroom-Docs.pdf

Has this been published to youtube somewhere? I would like to view the video and follow along with the notes. Thank you.

Login to comment on this ticket.

Metadata