Category: Documentation

All articles in this category are related to the Documentation team in the Fedora Project.

Contribution opportunity! Quick docs!

Quick docs are meant to be short articles on the official Fedora documentation site that cover commonly used workflows/tools.

Unlike wiki pages which are generally unreviewed, information on quick-docs follows the PR (peer-review + pull request) process. So the new information that is added there is more trustworthy and should be too, given that quick docs is listed on the official Fedora documentation website.

Continue reading

Fedora IoT Docs are Live

Fedora Internet of Things is a variant of Fedora focused on IoT ecosystems. This month I had the opportunity to focus on the Fedora IoT Documentation with the working group as a part advancing their objectives.

What was done

I began by expanding the “Getting Started” section to help people do as the title indicates: get started. This section is focused on getting the images downloaded and a device up and running with an initial user. The steps are detailed enough to help those that are also new to Fedora distributions.

Next I reorganized some of the remaining initial content into a “User Guide” section. This section covers topics thought of as the “next steps” in using the Fedora IoT images. I detailed the steps for managing updates with rpm-ostree and switching between development and stable builds. I also added examples for layered packages, adding repositories, and even running containers. Finally I provided some pointers for other administration tasks with links to existing Fedora Documentation

What is next

Design ideas: My focus was on technical content. The basic layout is dictated by the Fedora Docs project but a bit of design work on the welcome page and the addition of any IoT specific logos would be nice. Also, there are a few screenshots that could use a pointer or box to highlight the area described in the text.

Verify links for downloads and upgrades: The working group now has regular updated images available in a CDN and the next downloadable image is in progress along with the final version of the landing page for downloads. Once the update and release schedule process is smoothed out, the documentation needs to be verified.

Get ready for F30: When Fedora 30 is ready, the site will need some Release Notes and the User Guide will need some updates to cover new features. You can submit suggestions as iot-docs issues in pagure.

A lot of progress was made this month and I learned more about asciidoc, ostree, and my Pi device. Also that my fingers are too big for microSD cards!

Check out the content at https://docs.fedoraproject.org/en-US/iot/
Feedback is welcome — just let us know with an iot-docs issue or through any of the methods mentioned on the welcome page!

Design new Fedora Badges with the style guide

This week, the Fedora Badges team published a full walk-through of how to design new Fedora Badges on the Fedora Docs site. The walk-through is the best reference to use when designing new badges. It includes the following:

Continue reading

Documentation and Modularity at Flock 2017

If I had to choose one buzzword for Flock 2017 at Cape Cod, it would be ‘modularity’. Modules, module building, module testing, and module explaining seemed to be all over the place. I attended to give a workshop (with Aneta ŠP) about a proposed way to inject new life into the Fedora Documentation Project. Continue reading

Two Docs Workshops at Flock 2017

This year’s Flock saw two documentation workshops. One focused on reviving Fedora documentation as modular docs based on user stories. The other had participants helping to document Atomic Host features.

Continue reading

List of Flock blogs and more

If you’d like to get a bigger picture view, you can read a pre-conference interview with a few Flock speakers here or with Thomas Cameron here.

Days 3 and 4 were reserved for workshops. Also, during these 2 days, people continued to split into smaller groups to discuss matters of their own interests, and so did I. However, I caught up with some of the presenters to ask them about the outcome of their sessions and you can read that at the end of this article. But to be fair – if you want to read something about Flock, feel free to browse the blogs that emerged in the first post-Flock week, listed here:

Continue reading

Docs Project update from Flock 2016

At Flock 2016 in Krakow, Poland, I had the privilege of updating the community on the status of the Fedora Docs Project.

I made a small presentation and moderated a discussion in the Hackfest: Fedora Docs Learn and Hack panel. Unfortunately, my co-presenter and Fedora Docs Project Lead, Pete Travis, could not attend this year.  Therefore a lot of the conversation reflected my opinions and what I have gleaned from others.

The presentation slides are online. Unfortunately, the session wasn’t recorded or transcribed, so I wanted to try and present the conversation here. I am not attributing any comments in order to avoid mistakes. Additionally, I am working from my memory and the memory of other attendees, so omissions are accidental.

Two focuses for the Docs Project

There was a FAD in May 2016 to formulate ideas for moving the project forward. Two big ideas came out of this meeting:

Continue reading

You’re invited: FOSCo Brainstorm Meeting, 2016-07-18, 13:00 UTC

For some time now, Fedora has discussed the idea of the Fedora Outreach Steering Committee (FOSCo), a body to coordinate all our outreach efforts. Now it’s time to make it happen!

FOSCo brainstorming: you’re invited!

On behalf of FAmSCo and the Fedora Council, we would like to invite the Fedora community to an all-hands.

Roll call

So far, the following participants have confirmed attendance.

The fact that we already have a good team of volunteers should not stop you from attending. In fact, we would like to hear more voices from all stakeholders. The more, the better! To get an idea what FAmSCo has been working on so far, please have a look at the wiki page and current status.

None of this is set in stone yet, and we feel we need your input before we go any further. We are looking forward to your comments and to meet you next Monday!

Continue reading

Event Report: Fedora Docs FAD

Fedora Docs FAD 2016 Badge

The Documentation Fedora Activity Day held this past weekend in Raleigh, NC had an impressive collection of stakeholders across the Fedora, Red Hat and CentOS projects. It was certainly not your typical “hackathon” or “DocSprint.” There was much productive discussion, tools vetting, future planning, AND development.
Etherpad Export: Full Agenda and Notes
IRC Meeting Log: Friday
IRC Meeting Log: Saturday
IRC Meeting Log: Sunday
Docs FAD Fedora Badge

 

Continue reading

Copyright © 2019 Fedora Community Blog

Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License.

Theme by Anders NorenUp ↑