Request for Co-host/panelist: Docs workshop

Hi folks, I’m planning a virtual writing workshop from September 2023 as below.

Discussion thread
Preview article on workshop agenda

I would like to call for your participation as co-host/panelist of the monthly workshop in rotation.

Based on some stats and gut feel (interest and passion), here is a list of top contributors for documentation in all areas (review, UX/UI, docs build, maintenance, design and so on).

  • Repo: Pagure Quick Docs and Fedora Docs team repo (Docs website, build and contributor guide)
  • Criteria: Merge request opened, pushes, interactions in last three months (17 May - 17 August 2023)
  • Top contributors: Ankur Sinha(@ankursinha), Francois Andrieu(@darknao), Peter Boy(@pboy), Christopher Bush(@riddled), Frank Dana(@ferdnyc), Christopher Klooz(@py0xc3), Justin Flory(@jflory7), Joseph Gayoso(@joseph), Eduard Lucena(@x3mboy)

Another reason why we need a co-host is to keep discussion and content balanced and cover various areas of documentation projects.

Please let me know your interest. Looking forward to having you on the virtual workshop.

A draft agenda is here for your review.

Track 1. Introduction and onboarding (odd months)
– What Docs team is all about? What role will interest you?
– Type of user documentation Fedora Linux publishes
– How can you have a part in Fedora Documentation?

Track 2. Skill-based workshop (even months)
– Technical review, Git workshop, AsciiDoc template and attributes
– Use of local build and preview script
– Test documentation quality

3 Likes

I cannot make promises for September yet, but I try to be there :slight_smile: I guess at the moment I cannot contribute much to track 1 anyway :wink:

1 Like

September is a tough month for me, for family reasons, but I think I can manage myself to participate.

1 Like

Hot off the press!

See here for the proposal in the Fedora Magazine and when-is-good link for you to select time.

Intro and onboarding on track 1 is to raise awareness on documentation contributions for newbies. Your experience should definitely help onboarding session. For co-host/panelist, interaction with attendees and sharing experience matter. Both tracks don’t need slides. You’ll find Jitsi Meet link in Fedocal, Matrix and Fosstodon once a date is confirmed on September 15.

Track 2 needs sharing screen. But, both sessions will not be live-streamed. I could record the session with OBS Studio, edit footage with Kdenlive, and upload final cut to Peertube if you are okay with that.

Over time, we could change the way virtual workshop is run.

@x3mboy @py0xc3 please let me know your preferred timeslot here.

2 Likes

For co-host/panelist, here is some information you may find useful.

Tools

  • Video conferencing software
    Jitsi Meet, Google Meet or Hopin

Jitsi recently change the way meeting is hosted. The host requires an account. As I didn’t host Jitsi Meet before, there is a risk of mishap and friction in organizing the conference. Alternatively, I would use Google Meet I’m comfortable with. However, Google Meet free account is limited to an hour. Hopin offers 2 hours free.

Rehearsal or pre-meeting with co-host/panelist

  • Time
    We could have a video call to exchange ideas and prepare workshop
    – a 30-minute timeslot on any Thursdays: 7, 14 or 21 September
    – I’ll share the Google Meet or Hopin invite on fedora-docs room @ Fedora Matrix chat

Materials / visual aid

  • Track 1 (onboarding): No slides or presentation required
  • Track 2: screen sharing web browser and application (text editor or IDE). No slides or presentation required.

Types of interaction

  • Track 1: Round-table discussion on Docs contributor experience. Ask anything.
  • Track 2: Show and tell. Q&A

No live-streaming. No recording for track 1.

Generally, Matrix should offer video conferencing without restrictions, and every Fedorian with an FAS account should be able to attend it without any third-party account/software and such (and I guess most have been already around in Matrix channels, which might offer some additional comfort). We used that in the past for Fedora Social meetings. But this function was not enabled on all channels, and at the moment, it seems that I cannot start a video session even in Fedora Social.

@mattdm Do you know if there is a possibility to use Matrix for such workshops? It would be cool if we can use our own infra for things like that.

I need to consider new people without FAS account/Matrix experience. In the long-term, any other host/panelist in Docs team could switch to Matrix video call.

As a side, I had no luck joining Social hour using Matrix video call. I don’t even know how to start video call in Matrix.

I think you must be using the Element client (either the Electron thing via Flathub, or just in a browser).

For the Social Hour in specific, you must also join the Fedora Space — that’s a precaution against drop-in vandals.

1 Like

In that case, Matrix might be indeed less appropriate :wink: Looking forward to my first jitsi experience :smiley:

I assume a Matrix admin needs to start the session. It seems I have not sufficient privileges in the Fedora Social channel although I fulfill the mentioned conditions (web-version of Element, I’m in the Fedora space). I had in mind that I could start the video session in the past in Fedora Social, but maybe I mixed it up with something else (long time ago that I used Matrix for that). But thanks :slight_smile:

Please find a draft agenda for track 1 Welcome Day - Onboarding to discuss on a pre-meeting for co-host/panelist (@pboy @py0xc3 confirmed). Fedocal link for Jitsi Meet is here.

Agenda - rehearsal

  • Intro to Docs team: co-host
    Housekeeping: No recording

  • Intro to Docs Home page

  • Systems and accesses
    – Fedora Account
    – Fedora Docs Team page
    – Discussion - docs team tag
    – Matrix chat
    – List of Docs repo / Quick Docs

  • How can you have a part in Fedora documentation?
    – Release notes
    – Quick Docs: technical review, link checker, code samples/shell commands
    – Style guide
    – Site-wide improvement with CSS

  • Acronyms and glossary

  • Ask anything
    – Interaction with attendees

  • Pre-requisites for track 2
    – Wishlist from attendees

Video conferencing software

Jitsi Meet: I tried and tested on a KDE Plasma (Wayland, X11), GNOME Wayland, Android 13, Windows 11 Enterprise. Need to test on a Mac with @pboy .

Web browser: Firefox Version 117.0

Audio, Video, and screen sharing work fine.

Checklist for the host (me) and cohost;

  • If a lobby is enabled as set up by me
  • Audio level, latency and quality
  • Screen sharing test (on a Mac)
  • Any moderation required
  • Agenda: above is my thoughts. You are welcome to add yours.
2 Likes

@pboy It was a pleasure to have a video call today.

To join Jitsi Meet, you just need a web browser (desktop or mobile) as Jitsi is web native app. Compatible browser list is here.

You don’t need to install desktop client or mobile app.

I’ll share a follow-up schedule early next week. @py0xc3 @x3mboy

About counter-vandalism (Zoom–bombing), I use four options in Jitsi.

  • Pre-meeting screen
  • Enable lobby
  • Block video and audio
  • Kick out users

These options are quite common in other popular solutions like TEAMS, Zoom. Never had a chance to exercise my rights, but the safety button is already there.

[Edited]

Joining instructions

Jitsi Meet is a web native app that runs on your web browser without the need for Flash or any other plugins or extensions.

You do not need to download desktop client or mobile app to join Jitsi Meet meeting.

  1. Compatible web browser: Firefox, Safari, Chrome (all Chromium-based browsers), and Edge
  1. Meeting URL: meet.jit.si/fedoradocsworkshop

  2. When you enter the meeting URL, web browser will prompt you with camera and microphone permissions;

  • The meeting needs to use your microphone and camera. Select Share Selected Device when your browser asks for permissions.
  • Pop-up: Allow meet.jit.si to use your camera and microphone? Click “Allow”.

Site permissions - Firefox
permission2

Site permissions - Chrome
jitsi

It is recommended that all participants write their name or nickname, which will indicate who is speaking.

  • Tested with Firefox 117.0.1 and Chromium 117.0.5938.62 on a KDE Kinoite x11 display and Wayland
  1. Use unrestricted or unconfined user ID on your system that does not block video and audio sharing.

  2. Join the meeting with good internet connection to ensure smooth audio and video quality

  3. If you connect external device to your computer, make sure right device is selected for input and output.

  4. If we detect an egregious violation of the Fedora Community Code of Conduct, such incident will result in warning to the violated user and removal from the meeting.

  1. The meeting will not be recorded or live-streamed.

Above instructions will be shared on waiting room of Jitsi Meet before participants come to the meeting.

Meeting time will be updated on the Fedocal - docs - Fedocal

1 Like

Just for the records: Hank and me had a test session to check the MAC with the result, that the audio output didn’t work with the MAC. The compatibility sheet says, Safari has issues with “output device selection unsupported”. Because I have at least 2 Monitors, each with camera and audio, connected to my MacBook, this might be the cause. But we had the same issue with Firefox.

We need to do further testing.

To reduce the point of complexity, can you select one built-in camera on your Mac?

You can test audio and video using built-in screen recording feature on your Mac OS.

My test proven successful

  • My setup: Chrome and Chromium browser on a KDE Plasma with external microphone, Analog/digital converter, and monitoring headphone.

  • Guest setup 1: M2 Pro Macbook Pro with Chrome browser. Built-in audio.

  • Guest setup 2: Fedora 38 Workstation GNOME with Chrome browser. Built-in audio.

  • Recording: OBS Studio. Sound quality excellent

Hi folks, here is a checklist for co-presenters on 28 September.

  • Connect your computer to strong Wifi signal

  • Lighting: face light in your front (behind the webcam)

  • Display settings in desktop: Enable presentation mode, so the screen does not get locked. Don’t connect a second monitor for track 1.

  • Sound: If Linux, check sound profile for microphone and headphone. Use alsaamixer or pavucontrol to check soundcard, microphone, master/device volume. Test the sound with screen recording to avoid sound distortion.

  • Web browser: Chrome or Chromium recommended

  • Authenticate your Jitsi login with Google account if you want to moderate meetings

  • Enter name or nickname in Jitsi UI to join

  • Recording: No recording for track 1. Track 2 only. OBS studio test done by Hank Lee

  • Show and tell without presentation slides. Please be prepared to talk through if video or screen sharing fail. Don’t read screen-prompter or script. If all fail, carry on with audio only.

  • Promote what’s available and works well

For scheduling the next workshop in October, here is a 1 hour time slot for co-host to choose;
2023-10-19T18:00:00Z2023-10-19T19:00:00Z
2023-10-26T18:00:00Z2023-10-26T19:00:00Z

Topics
Technical review 1 - Quick Docs

Timetable
What articles to choose / Show and tell: 10 minutes
Write and edit Quick Docs: 40 minutes (Live chat for help)
Ask anything and share: 10 minutes

Video conferencing software
Jitsi Meet Moderated
A new link will be published on the Fedocal.
No installation required.

Pre-requisites
Fedora Account and Pagure login

Please respond to this thread by Tuesday 10 October if any volunteers want to join me as a co-host. A timetable and agenda need to be confirmed and published well in advance in the Fedocal.

Peter Boy and I chatted about rehearsal on weekly Docs IRC meeting on 11 October.

Rehearsal
Please join the rehearsal meeting on 2023-10-19T18:00:00Z2023-10-19T18:30:00Z on the link below.

Let’s discuss agenda and how we organize the workshop.

  • Why technical review?
  • What criteria do we need to select articles for reviews?

In Quick Docs, there is certainly plenty of room for improvement.

The meeting link for rehearsal and workshop is here.

Please note the link will change every month.

October workshop schedule
The workshop is on 2023-10-26T18:00:00Z2023-10-26T19:00:00Z

I set up Jitsi in Matrix. I think we need transition time for folks to join Jitsi in Matrix. Also co-hosts need time to get used to the built-in Jitsi experience. To avoid confusion, I would share the details after the October workshop.

  • Jitsi Meet (meet.jit.si link shared above): October - December 2023
  • Communication and test between co-host: November 2023
  • Fedora Matrix chat room to join Jitsi video call: January 2024

Thanks for your note. I didn’t realize there is a separate room for Social Hour video call.

To improve workshop, could we consider

Build workshop agenda and share it in advance

Here is a link to shared team doc (Etherpad) that co-host/panelist can build workshop program collaboratively. Your feedback is welcome. If right audience joins, we would expect more interactivity.

Go the link below and edit the agenda directly.

https://scalar.vector.im/etherpad/p/fedora-test

Improve audio quality

Reearch on audio quality shows the effects of different audio quality on the ratings of two science talks on YouTube.

Ensure your audio is high quality when joining the workshop, so we can deliver professional recording to contributors, who missed the workshop and want to watch the video at a later time at Peertube.

Co-hosts are recommended to:

  • Get yourself a high quality external directional microphone, which helps suppress room reflections and background noise. Alternatively, use noise-cancelling headset or earbuds you already have. Built-in microphone that comes with your laptop/monitor picks up noise from everywhere.
  • Use a stable and strong internet connection
  • Minimize background noise
  • Test your sound with audio recording software

Virtual meeting and training are lifeline of the growth of our community and contributors.

Elocution
To sound intelligible to your audience, confident and deliver quality content,

  • Speak in a fluid way
  • Increase your verbal clarity
  • Speak more confidently without adding extra words
  • Give an impression that you’re prepared (but do not sound overly rehearsed)
  • Use clear pronunciation and good breathing to control the voice

Fine details

  • Use of workspaces (Spaces in Mac) to switch terminal, web browser and slides (rather than alt + tab)
  • Zoom in when you click tiny UI button and verbalize what you’re going to do
  • Enable presentation mode to prevent the screen from going to sleep
  • Avoid using noise suppression option, virtual background or blurred screen in Jitsi as this might affect video quality

Extra tips

  • If you’re interested in clean sound, there are a couple of microphones that help you record/live-stream your voice close to broadcast quality in imperfect rooms.
    – Use dynamic cardioid microphones that reject off-axis sound and background noise
    – If you are looking for upgradability and flexibility, consider XLR microphone instead of USB
    – Check if the power outlet (extension) is not faulty. If defective, replace it with a new one.
    – Unplug printers and any other electric appliances on the power socket to avoid electromagnetic interference