From Fedora Project Wiki

(→‎Guides: Updating links to Wireless Guide)
(Mention Antora, improve transclusion characteristics)
 
(68 intermediate revisions by 23 users not shown)
Line 1: Line 1:
{{Autolang|base=yes}}<onlyinclude>
== Guides ==
== Guides ==
This table discusses who owns which documentation guide. All of these guides are a work in progress. Some of them are slated for the [[Docs_Project_guide_goals_for_F{{PRODVER}}|Fedora {{PRODVER}} release]] when noted with an "F{{PRODVER}}" below. Join the fun by contacting the guide owner or adopting an orphaned guide. Have an idea for a guide not yet in this list? Bring it up on the [https://admin.fedoraproject.org/mailman/listinfo/docs Docs Project list].
  ▶ ''These guides may be transcluded in other places, but they originate [[Docs Project guides table|here]].''


{| class="wikitable sortable"
The documentation system has migrated from [[Publican]] to [https://antora.org/ Antora], which uses [https://docs.asciidoctor.org/asciidoc/latest/ AsciiDoc]. The active projects list can be found on [https://pagure.io/fedora-docs/ Pagure].
! Guide Name !! F !! Guide Lead !! QA Contact !! Wiki !! Repo !! L10N Priority !! In translation !! RPM !! HTML (docs.fp.o)
|-----bgcolor="#AAEEAA"
| [http://docbook.sourceforge.net/ docbook-locales] || - || [[User:Rlandmann|rudi]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docbook-locales.git;a=summary Fedora Git]; [http://docbook.svn.sourceforge.net/viewvc/docbook/trunk/gentext/locale/ Upstream SVN] || 1 || [https://www.transifex.net/projects/p/fedora-docbook-locales/ Yes] || [https://admin.fedoraproject.org/pkgdb/acls/name/docbook-style-xsl Yes] || Used to produce all guides on d.fp.o
|-----bgcolor="#AAEEAA"
| [https://fedorahosted.org/publican/ Common_Content for Publican] || - || [[User:Rlandmann|rudi]] || [[User:Anross|anross]] || No || [http://svn.fedorahosted.org/svn/publican/trunk/ SVN] || 2 || [https://translate.zanata.org/zanata/project/view/publican-common Yes] || [https://admin.fedoraproject.org/pkgdb/acls/name/publican Yes] || Used to produce all guides on d.fp.o
|-----bgcolor="#AAEEAA"
| [https://fedorahosted.org/publican/ Publican branding for Fedora] || - || [[User:Rlandmann|rudi]] || [[User:Anross|anross]] || No || [http://svn.fedorahosted.org/svn/publican/trunk/ SVN] || 3 || [https://translate.zanata.org/zanata/project/view/publican-fedora Yes] || [https://admin.fedoraproject.org/pkgdb/acls/name/publican-fedora Yes] || Used to produce all guides on d.fp.o
|-----bgcolor="#AAEEAA"
| Documentation website || - || [[User:Rlandmann|rudi]] || [[User:Anross|anross]] || No || [http://git.fedorahosted.org/git/?p=docs/docsite-publican.git;a=summary Git] || 4 || [https://www.transifex.net/projects/p/fedora-docsite-publican/ Yes] || No || Welcome and explanatory text for docs.fp.o
|-----bgcolor="#DDDDDD" class="sortbottom"
|&nbsp; || || || || || || || || ||
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/accessibility-guide/ Accessibility Guide] || F14 || [[User:Sparks|Sparks]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/accessibility-guide.git;a=summary Git] || 9 || [https://www.transifex.net/projects/p/fedora-accessibility-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora/14/html/Accessibility_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/amateur-radio-guide/ Amateur Radio Guide] || F14 || [[User:Jjmcd|jjmcd]], [[User:Sparks|Sparks]] || sign up! || No  || [http://git.fedorahosted.org/git/?p=docs/amateur-radio-guide.git;a=summary Git] || || [https://www.transifex.net/projects/p/fedora-amateur-radio-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora/14/html/Amateur_Radio_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/readme-burning-isos/ Burning ISOs] || F18 || [[User:bcotton|bcotton]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/readme-burning-isos.git;a=summary Git] || *  || [https://www.transifex.net/projects/p/fedora-readme-burning-isos/ Yes] || No || [http://docs.fedoraproject.org/readme-burning-isos/ Yes]
|-----bgcolor="#FFFFFF"
| Cloud Guide || F16 || [[User:Sparks|Sparks]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/cloud-guide.git;a=summary Git] || || [https://www.transifex.net/projects/p/fedora-cloud-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Cloud_Guide/index.html Yes]
|-----bgcolor="#F5A9A9"
| [https://fedorahosted.org/deploymentguide/ Deployment Guide] || F15 || [[User:Dsilas|dsilas]], [[User:Jhradile|jhradile]] || [[User:Crantila|crantila]] || No || [http://git.fedorahosted.org/git/?p=docs/deployment-guide.git;a=summary Git] || † || No || No || [http://docs.fedoraproject.org/en-US/Fedora/14/html/Deployment_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/documentation-guide/ Documentation Guide] || - || [[User:Sparks|Sparks]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/documentation-guide.git;a=summary Git] || || No || No || [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Documentation_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
| Elections Guide || - || [[User:Sparks|Sparks]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/elections-guide.git;a=summary Git] ||  || [https://www.transifex.net/projects/p/fedora-elections-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora_Contributor_Documentation/1/html/Fedora_Elections_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/freeipa-guide/ FreeIPAGuide] || F17 || [[User:elladeon|elladeon]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/freeipa-guide.git;a=summary Git] || n/a || No || No || [http://docs.fedoraproject.org/Fedora/17/html/FreeIPA_Guide/index.html Yes]
|-
| [https://fedorahosted.org/install-guide/ Installation Guide] || F18 || [[User:Ke4qqq|ke4qqq]], [[User:jjr|jreed]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/install-guide.git;a=summary Git] || 7 || <!--[https://www.transifex.net/projects/p/fedora-install-guide/ Yes]--> No†† || No || [http://docs.fedoraproject.org/install-guide/ Yes]
|-
| [https://fedorahosted.org/installation-quick-start-guide/ Installation Quick Start Guide] || F17 || [[User:Ke4qqq|ke4qqq]], [[User:jjr|jreed]] || [[User:Jhradile|jhradile]] || No || [http://git.fedorahosted.org/git/?p=docs/installation-quick-start-guide.git;a=summary Git] || 6 || <!--[https://www.transifex.net/projects/p/fedora-ins-quick-start-guide/ Yes]--> No†† || No || [http://docs.fedoraproject.org/installation-quick-start-guide/ Yes]
|-
| [https://fedorahosted.org/jargon-buster/ Jargon Buster] || F14 || [[User:Sparks|Sparks]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/jargon-buster.git;a=summary Git] || * || No || No || No
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/readme-live-image/ Live Images] || F18 || [[User:bcotton|bcotton]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/readme-live-image.git;a=summary Git] || * || [https://www.transifex.net/projects/p/fedora-readme-live-images/ Yes] || No || [http://docs.fedoraproject.org/readme-live-image/ Yes]
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/musicians-guide/ Musicians' Guide] || F15 || [[User:Crantila|crantila]]  || sign up! || [[User:Crantila/FSC|Outdated]] || [http://git.fedorahosted.org/git/?p=docs/musicians-guide.git;a=summary Git] ||  || [https://www.transifex.net/projects/p/fedora-musicians-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora/15/html/Musicians_Guide/index.html Yes]
|-
| [https://fedorahosted.org/openssh-guide/ OpenSSH Guide] || F14 || [[User:kennepede|kennepede]] || sign up! || No || [http://svn.fedorahosted.org/svn/openssh-guide/ SVN] || || No || No || [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.2/html/OpenSSH_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/packagers-guide/ Packager's Guide] || F18 || [[User:pmkovar|pmkovar]] || [[User:fnadge|fnadge]], [[User:Jhradile|jhradile]] || No || [http://git.fedorahosted.org/git/?p=docs/packagers-guide.git;a=summary Git] || || [https://fedora.transifex.net/projects/p/packagers-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Packagers_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
|Power Management Guide || F14 || [[User:jjr|jreed]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/power-management-guide.git;a=summary Git ] || || [https://www.transifex.net/projects/p/fedora-power-management-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora/14/html/Power_Management_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/release-notes/ Release Notes] || F15 || [[User:Jjmcd|jjmcd]], [[User:ryanlerch|ryanlerch]] || [[User:Zoglesby|zoglesby]] || [http://fedoraproject.org/wiki/Documentation_Beats Beats] || [http://git.fedorahosted.org/git/?p=docs/release-notes.git;a=summary Git ]  || 5 || [https://www.transifex.net/projects/p/fedora-release-notes/ Yes ]  || [https://admin.fedoraproject.org/pkgdb/acls/name/fedora-release-notes Yes] || [http://docs.fedoraproject.org/release-notes/ Yes ]
|-
|[https://fedorahosted.org/resource-management-guide/ Resource Management Guide] || F17 || [[User:Mprpic|mprpic]] || sign up! || [https://fedorahosted.org/resource-management-guide/ Yes]||[http://git.fedorahosted.org/git/?p=docs/resource-management-guide.git;a=summary Git] || || [https://www.transifex.net/projects/p/resource-management-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora/15/html/Resource_Management_Guide/index.html Yes]
|-
| [https://fedorahosted.org/rpmguide/ RPM Guide] || - || [[User:bcotton|bcotton]], [[User:pmkovar|pmkovar]] || sign up! || [https://fedoraproject.org/wiki/RPM_Guide_tasks Yes] || [http://git.fedorahosted.org/git/?p=docs/rpm-guide.git;a=summary Git] || || [https://www.transifex.net/projects/p/fedora-rpm-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
| [https://fedorahosted.org/securityguide/ Security Guide] || F18 || [[User:Sparks|sparks]],  [[User:kennepede|kennepede]] || [[User:bcotton|bcotton]] || [http://fedoraproject.org/wiki/Archive:Security_Guide Archived] || [http://git.fedorahosted.org/git/?p=securityguide.git;a=summary Git] || 10 || [https://www.transifex.net/projects/p/fedora-security-guide/ Yes] || No || [http://docs.fedoraproject.org/security-guide/ Yes]
|-
| SELinux FAQ || F14 ||  [[User:kennepede|kennepede]] || sign up! || No || [http://svn.fedorahosted.org/svn/selinux-faq/community SVN] ||  || No || No  || [http://docs.fedoraproject.org/selinux-faq/ Yes]
|-
| [https://fedorahosted.org/managing-confined-services/ SELinux Managing Confined Services Guide] || F14 ||  [[User:kennepede|kennepede]] || sign up! || No || [http://svn.fedorahosted.org/svn/managing-confined-services/community SVN] ||  || [https://www.transifex.net/projects/p/fedora-managing-confined-svcs/ Yes] || No  || [http://docs.fedoraproject.org/selinux-managing-confined-services-guide/en-US/F11/html-single/ Yes]
|-
| [https://fedorahosted.org/selinuxguide/ SELinux User Guide] || F17 ||  [[User:mprpic|mprpic]] || sign up! || No || [http://svn.fedorahosted.org/svn/selinuxguide/community/ SVN] || || No || No || [http://docs.fedoraproject.org/selinux-user-guide/ Yes]
|-----bgcolor="#FFFFFF"
|[https://fedorahosted.org/software-collections-guide/ Software Collections Guide] || F17 || [[User:pmkovar|pmkovar]] || [[User:fnadge|fnadge]], [[User:Jhradile|jhradile]] || No || [http://git.fedorahosted.org/git/?p=docs/software-collections-guide.git;a=summary Git] ||  || [https://www.transifex.net/projects/p/software-collections-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Software_Collections_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
|[http://rpmdev.proyectofedora.org/projects/mpgdsw Software Management Guide] || F16 || [[User:Gomix|Gomix]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/software-management-guide.git;a=summary Git] ||  || [https://www.transifex.net/projects/p/fedora-software-mgmt-guide/ Yes] || No || [http://docs.fedoraproject.org/es-ES/Fedora/16/html-single/Software_Management_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
|Storage Administration Guide || F14 || [[User:Ddomingo|Ddomingo]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/storage-administration-guide.git;a=summary Git] || || [https://www.transifex.net/projects/p/fedora-storage-admin-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora/14/html/Storage_Administration_Guide/index.html Yes]
|-----bgcolor="#FFFFFF"
| System Administrator's Guide || F18 || [[User:Jhradile|jhradile]] || [[User:Crantila|crantila]] || No || [http://git.fedorahosted.org/git/?p=docs/system-administrators-guide.git;a=summary Git] || 8 || [https://www.transifex.net/projects/p/system-administrators-guide/ Yes] || No || [http://docs.fedoraproject.org/en-US/Fedora/16/html/System_Administrators_Guide/index.html Yes]
|-
| Technical Notes || F17 || [[User:immanetize|randomuser]] || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/technical-notes.git;a=summary Git ]  ||  || [https://www.transifex.net/projects/p/fedora-technical-notes/ Yes]  || No || [http://docs.fedoraproject.org/technical-notes/ Yes ]
|-
| [http://git.fedorahosted.org/git/?p=docs/uefi-secure-boot-guide.git;a=summary UEFI Secure Boot Guide] || F18 || [[User:sparks|Sparks]] || || No || [http://git.fedorahosted.org/git/?p=docs/uefi-secure-boot-guide.git;a=summary Git] || || [https://www.transifex.com/projects/p/fedora-uefi-secure-boot-guide/ Yes] || No || No
|-
| [https://fedorahosted.org/userguide/ User Guide] || F17 || [[User:rforlot|rforlot]], [[User:Fnadge|Fnadge]] || [[User:Jhradile|jhradile]], [[User:pmkovar|pmkovar]] || [http://fedoraproject.org/wiki/F11_User_Guide F11 only] || [http://git.fedorahosted.org/git/?p=docs/user-guide.git;a=summary Git] || 8 || [https://www.transifex.net/projects/p/fedora-user-guide/ Yes] || No || [http://docs.fedoraproject.org/user-guide/ Yes]
|------bgcolor="#F5A9A9"
| [https://fedorahosted.org/Virtualization_Guide/ Virtualization Guide]††† || F14 ||  || sign up! || No || [http://git.fedorahosted.org/git/?p=docs/virtualization-guide.git;a=summary Git] || || No || No || [http://docs.fedoraproject.org/virtualization-guide/f13/en-US/html-single/ Yes]
|------bgcolor="#FFFFFF"
|Virtualization Administration Guide&#42;&#42;||F18||[[User:Lnovich|lnovich]]||sign up!||No ||[http://git.fedorahosted.org/git/?p=docs/virtualization-administration-guide.git;a=summary Git]|| || No ||No || No
|-
|Virtualization Deployment Guide&#42;&#42;||F18||[[User:laubai|laubai]]||sign up!||No || [http://git.fedorahosted.org/git/?p=docs/virtualization-deployment-guide.git;a=summary Git] || || No ||No || No
|-
|Virtualization Getting Started Guide&#42;&#42;||F18||[[User:dmparker|dmparker]]||sign up!||No || [http://git.fedorahosted.org/git/?p=docs/virtualization-getting-started-guide.git;a=summary Git]  || || [https://www.transifex.com/projects/p/fedoravirtgettingstartedguide/ Yes] || No || No
|-
|Virtualization Security Guide&#42;&#42;||F18||[[user:sradvan|sradvan]]||sign up!||No|| [http://git.fedorahosted.org/git?p=docs/virtualization-security-guide.git;a=summary Git] || || No || No || No
|-
| Wireless Guide || F17 || StephenW || sign up! || No || [http://git.fedorahosted.org/git?p=docs/wirelessguide.git;a=summary Git] ||  || [https://www.transifex.net/projects/p/fedora-wireless-guide/ Yes] || No  || [http://docs.fedoraproject.org/wireless-guide/f17/en-US/html-single/ Yes]
|-
|}


&#42; This document is low priority, but is short and easy text ideal for new documentation translators.
=== [[Docs Project old guides|Old guides]] ===
</onlyinclude>


† The Deployment Guide has been renamed to System Administrator's Guide.
&#42;&#42; Replaces the Virtualization Guide from F14 onwards.
†† The Installation Guide and Installation Quick Start Guide are now translated in Zanata due to problems on Transifex with the number of files and the length of file names.
††† Development has ceased as it is now divided into new guides - watch for news.
{{Admon/important | Please use "Yes", "No", "Archived", "In Progress", or "Due on..." in each block to denote current status.}}
{|
!Status
|-
|Still under development
|-----bgcolor="#FFFF99"
|Branched for F{{PRODVER}}
|-----bgcolor="#AAEEAA"
|Branched, in translation, and drafts on d.fp.o
|-----bgcolor="F5A9A9"
|Development has ceased
|}


[[Category:Docs Project tasks]]
[[Category:Docs Project tasks]]

Latest revision as of 00:56, 21 July 2024

Guides

  ▶ These guides may be transcluded in other places, but they originate here.

The documentation system has migrated from Publican to Antora, which uses AsciiDoc. The active projects list can be found on Pagure.

Old guides