{"id":124443,"date":"2022-05-02T08:57:00","date_gmt":"2022-05-02T08:57:00","guid":{"rendered":"https:\/\/fedoramagazine.org\/?p=36387"},"modified":"2022-05-02T08:57:00","modified_gmt":"2022-05-02T08:57:00","slug":"improvements-to-fedora-docs","status":"publish","type":"post","link":"https:\/\/sickgaming.net\/blog\/2022\/05\/02\/improvements-to-fedora-docs\/","title":{"rendered":"Improvements to Fedora Docs"},"content":{"rendered":"

The Docs team<\/a> is experiencing a new burst of energy. As part of this, we have several big improvements to the Fedora Docs site<\/a> that we want to share.<\/p>\n

<\/span> <\/p>\n

<\/a>Searchable docs<\/h2>\n

For years, readers have asked for search. We have a lot of documentation on the site, but you sometimes struggle to find what you\u2019re looking for. With the new search feature, you can search the entire Fedora Documentation content.<\/p>\n

Lunr.js<\/a> powers the search. This means your browser downloads the index and does the search locally. The advantage is that there are no external dependencies: searches send nothing to a remote server and there is no external Javascript required. The downside is that the index has to be downloaded before search is available. Although we compress the index, if you\u2019re on a slower connection, you may experience delays.<\/p>\n

While the search is a major improvement, it\u2019s not perfect. The search tool is not aware of the context of your search and can\u2019t offer \u201cdo you mean _ ?\u201d suggestions. Also, because many pages have similar titles, you can\u2019t always tell which page has the information you\u2019re looking for. We\u2019re looking into adding more context to the page titles and working with teams to make titles more useful.<\/p>\n

<\/a>Stable \u201clatest\u201d URL<\/h2>\n

Many times when you link to a page on Fedora Docs, you don\u2019t care about the version number. For example, if you\u2019re writing a blog post that links to the Installation Guide, you\u2019d rather it go to the Installation Guide for the latest version. If you don\u2019t actively update your links to Fedora Docs, they grow stale over time.<\/p>\n

We recently added a stable \/latest<\/em> URL for release docs. For example, https:\/\/docs.fedoraproject.org\/en-US\/fedora\/latest\/<\/a> points to the Fedora Linux 35 documentation. When we release Fedora Linux 36, soon, that URL will point to F36 documentation. You can use this stable URL when you want to target the latest released version and only use specific versions in the URL when the version matters.<\/p>\n

<\/a>Redesigning the site<\/h2>\n

Over the next few months, we\u2019re working on a two-pronged approach to documentation. First, we want the user documentation to better reflect the changes in the Fedora distribution over the last few years. In the meantime, there are great differences in terms of installation and administration, which makes uniform guides difficult to write. In fact, most Editions now have their own installation guide. As a first step, we will split the current installation guide into a guide describing where to find the installation guide for the appropriate Edition. It will also include a generic description of Anaconda that Editions can link to or include text parts. We expect to be able to connect the customization during the Fedora Linux 37 development cycle. As a next step, we will revise the Administration Guide and Quick Docs.<\/p>\n

In addition, the Docs team will be selecting an Outreachy intern to work on a redesign of the site. This will include both the graphical design of the user interface as well as improving the information architecture of the site. We want to make it easier for you to find exactly what you\u2019re looking for.<\/p>\n

<\/a>Help wanted<\/h2>\n

Just like the rest of Fedora, the Docs team is a community effort. We welcome new contributors. You can join us in the #docs tag on Fedora Discussion<\/a> or in #docs on Fedora Chat<\/a>.<\/p>\n

If you see an issue on any Fedora Docs page, you can click the bug icon on the top of the page to report an issue. Or click the edit icon to submit a correction!<\/p>\n","protected":false},"excerpt":{"rendered":"

The Docs team is experiencing a new burst of energy. As part of this, we have several big improvements to the Fedora Docs site that we want to share. Searchable docs For years, readers have asked for search. We have a lot of documentation on the site, but you sometimes struggle to find what you\u2019re looking for. With the new search feature, […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[48],"tags":[45,46,75,47],"class_list":["post-124443","post","type-post","status-publish","format-standard","hentry","category-fedora-os","tag-fedora","tag-magazine","tag-new-in-fedora","tag-news"],"_links":{"self":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/124443","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/comments?post=124443"}],"version-history":[{"count":0,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/124443\/revisions"}],"wp:attachment":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media?parent=124443"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/categories?post=124443"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/tags?post=124443"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}