documentation Archives – Fedora Community Blog

Tag: documentation (page 1 of 2)

Lit jack-o-lanterns in a dark location with the white text "Hacktoberfest"

Contribute to the Fedora Project during Hacktoberfest 2022

September 29, 2022 / t0xic0der / Comments Off

Allow us to wake you up when September ends because Hacktoberfest is (nearly) here. And you can contribute to the Fedora Project while participating in Hacktoberfest 2022! This event is an excellent opportunity to advocate for free and open-source software, all while giving back to the community with the contribution of your choice. Hacktoberfest includes low and non-code contributions. You can diversify your contributions to include writing docs, creating designs, running tests, mentoring folks, and much more. This global event is open for anyone, from students to professionals. People of all backgrounds and skill levels are encouraged to join us.

Fedora docs is about to change significantly! Check it out still in statu nascendi.

May 31, 2022 / pboy / 5 Comments

In a recent Fedora Magazine article we shared about a new burst of energy regarding the Fedora docs. We already implemented various improvements and worked on a plan to generally improve and update Fedora documentation.

The latter will lead to far-reaching changes in Fedora documentation and is about to happen now and entail continuous changes over the next approximately 12 months. We present here our analysis, our content concept and our implementation planning. We hope for ideas from the community to further enhance the concept and for support to turn it into reality.

Fedora documentation is now multilingual

July 9, 2020 / Jean-Baptiste Holcroft / 3 Comments

The Fedora project documentation website provides a lot of end-users content. All of this content is now translateable, providing a powerful tool for our multilingual communication. Writers will continue to work as usual. The publishing tools automatically convert content and push it to the translation platform. Then, translated content is automatically published.

Fedora Happiness Packets - project update

My Outreachy 2019 experience with Fedora Happiness Packets: Contribution phase

March 29, 2019 / phoenixabhishek / Comments Off

Firstly, what’s Outreachy?

Outreachy is a program that provides internships to work in Free and Open Source Software (FOSS). Outreachy internships are open to applicants around the world. Interns work remotely, and are not required to move. Interns are paid a stipend of $5,500 USD for the three month internship. Interns have a $500 USD travel stipend to attend conferences or events.

How did I get into it?

I was looking for a remote job (more on this in another blog) and have been applying to many positions that I thought I would fit in. If you have applied to jobs, you would know that this process is not very forgiving. Most of the applications had no response, and some others already had the positions filled (I don’t know why was the job listing not taken down 😕).

During this process I was actively learning new things, mostly JS based since my basic stack is HTML-CSS-JS. So I was learning NodeJs, MongoDB, React to build up my skill-set and get better at what I want to do.

Fedora IoT Docs are Live

February 28, 2019 / Susan Lauber / 1 Comment

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

February 5, 2019 / Justin W. Flory / Comments Off

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:

Fedora Badges Style Guide
Setting up Inkscape (color palettes, typeface)
Templates for new badges and design templates

Teaching metrics and contributor docs at Flock 2017

October 19, 2017 / Justin W. Flory / 9 Comments

The Fedora Community Operations (CommOps) team held an interactive workshop during the annual Fedora contributor conference, Flock. Flock took place from August 29th to September 1st in Cape Cod, Massachusetts. Justin W. Flory and Sachin Kamath represented the team in the workshop. CommOps spends a lot of time working with metrics and data tools available in Fedora, like fedmsg and datagrepper. Our workshop introduced some of the tools to work with metrics in Fedora and how to use them. With our leftover time, we discussed the role of contributor-focused documentation in the wiki and moving it to a more static place in Fedora documentation.

Documentation and Modularity at Flock 2017

September 20, 2017 / rkratky / Comments Off

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

September 20, 2017 / aneta / Comments Off

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.

List of Flock blogs and more

August 18, 2016 / nardasev / 1 Comment

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: