diff options
Diffstat (limited to 'tmp/en-US/xml/Documenting_Fedora/writing_recipes.xml')
| -rw-r--r-- | tmp/en-US/xml/Documenting_Fedora/writing_recipes.xml | 198 |
1 files changed, 0 insertions, 198 deletions
diff --git a/tmp/en-US/xml/Documenting_Fedora/writing_recipes.xml b/tmp/en-US/xml/Documenting_Fedora/writing_recipes.xml deleted file mode 100644 index 68a6af1..0000000 --- a/tmp/en-US/xml/Documenting_Fedora/writing_recipes.xml +++ /dev/null @@ -1,198 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY YEAR "2014"> -<!ENTITY HOLDER "| You need to change the HOLDER entity in the en-US/Fedora_Cookbook.ent file |"> -<!ENTITY PRODUCT "Fedora Documentation"> -<!ENTITY BOOKID "cookbook"> -<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=&PRODUCT;&component=&BOOKID;'>http://bugzilla.redhat.com/</ulink>"> - -]> -<section id="writing_recipes" lang="en-US"> - <!-- Do not edit above this line --><!-- - Please provide some information so we can give you credit: - name: YOUR_NAME - fas_id: YOUR_FEDORA_ACCT ( to verify you have signed the CLA ) - email: YOUR_EMAIL ( so the docs team can talk to you, not for publication ) - article_category: category you'd like the tutorial to be published into. - --> <title>Writing Recipes</title> - <para> - Writing recipes for the Fedora Cookbook is easy! Use a provided template to get started, submit your tutorial to the Fedora Documentation team for review, and we'll publish. - </para> - <section id="writing_recipes-ingredients"> - <title>Required Ingredients</title> - <!-- list packages, services, other recipes etc that are required --> <itemizedlist> - <listitem> - <para> - <emphasis>Article template</emphasis> from <ulink url="https://git.fedorahosted.org/cgit/docs/fedora-cookbook.git/tree/en-US/examples">the provided examples.</ulink> - </para> - - </listitem> - <listitem> - <para> - <emphasis>Your favorite text editor.</emphasis> You can use whatever you prefer, but please save them as a plain text file instead of a binary format such as <literal>ODF</literal> - </para> - - </listitem> - <listitem> - <para> - <emphasis>A topic</emphasis>. You will need something to write the tutorial about! - </para> - - </listitem> - <listitem> - <para> - <emphasis>A reviewer</emphasis>. When you submit your tutorial, a Fedora Docs team member will help you review the content to make sure it is clear and understandable. - </para> - - </listitem> - <listitem> - <para> - <emphasis>A license</emphasis>. We need your permission to distribute your work and help keep it up to date. - </para> - - </listitem> - - </itemizedlist> - - </section> - - <section id="writing_recipes-directions"> - <title>Directions</title> - <procedure> - <title>Creating a New Tutorial</title> - <step> - <para> - Choose a topic. The focus of the article should be clear, and you should be able to achieve the goal in a short series of steps. If the process is complex, consider splitting into a series of smaller articles. - </para> - <important> - <title>Write about Fedora!</title> - <para> - Fedora Documentation should be only cover capabilities that Fedora can provide. Fedora is about free software, and the docs should be as free as the code. - </para> - <para> - Submissions that require software not available in Fedora should be avoided. Tutorials that require software that is <ulink url="https://fedoraproject.org/wiki/Forbidden_itemshttps://fedoraproject.org/wiki/Forbidden_items">not permissible</ulink> for Fedora cannot be accepted. - </para> - - </important> - - </step> - <step> - <para> - Download a template from <ulink url="https://git.fedorahosted.org/cgit/docs/fedora-cookbook.git/tree/en-US/examples">the repository</ulink> maintained by the Fedora Docs team. Choose the format you like, then click <guilabel>plain</guilabel> to get it in a format you can cut and paste into an editor. - </para> - <itemizedlist> - <listitem> - <para> - An introduction. - </para> - - </listitem> - <listitem> - <para> - A list of <literal>ingredients</literal> required to complete the tutorial - </para> - - </listitem> - <listitem> - <para> - The procedural instructions. - </para> - - </listitem> - <listitem> - <para> - References to resources or other content on the same subject. - </para> - - </listitem> - - </itemizedlist> - <para> - You can submit your tutorials in any understandable format. Eventually, it will be converted to DocBook, but the content is more important than the format. Choose a format you are comfortable with. - </para> - - </step> - <step> - <para> - Write an introduction to your tutorial. It doesn't need to be long, but the reader should have a good idea of the results. - </para> - - </step> - <step> - <para> - Write an outline of the procedure you want to document. This outline doesn't need to be detailed yet, just give an overview of the steps needed. - </para> - - </step> - <step> - <para> - Follow your outline and fill in the details. Start with the minimum acceptable configuration, and add the minimal configuration to the <literal>ingredients</literal> list. - </para> - <para> - If possible, you should use a virtual machine or a clean user account. You can miss important steps because of local changes to installed packages or user configuration files. - </para> - - </step> - <step> - <para> - Make sure that your directions achieve the desired result. If there are steps that would be better in a seperate recipe, you should reference the other recipe. If it doesn't exist, you can write that first or request that it be written. - </para> - - </step> - <step> - <para> - Update your ingredients list with the requirements you found when testing the instructions. - </para> - - </step> - <step> - <para> - License your content. If you have an FAS account and have agreed to the <ulink url="https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement">Fedora Contributor Agreement</ulink>, that's good enough. This defaults to <ulink url="http://creativecommons.org/licenses/by-sa/3.0/legalcode">CC-BY-SA</ulink>, used by most Fedora Documentation. - </para> - <para> - If you want to use another license, you must declare it. The license must allow redistribution and modification, at least for non-commercial purposes. If you have questions about licensing, ask. - </para> - - </step> - <step> - <para> - Submit your tutorial to the <ulink url="https://admin.fedoraproject.org/mailman/listinfo/docs-qa">Fedora Docs Quality Assurance mailing list</ulink> for review. - </para> - <para> - Fedora Docs volunteers will check over your tutorial and work with you to improve it. We want to teach you how to write good content, just like you want to help users with the subject of the tutorial. - </para> - - </step> - <step> - <para> - After the review, a Fedora Docs volunteer will help find the best place for your content. Most <literal>recipes</literal> will probably end up in the <citetitle>Fedora Cookbook</citetitle>, but you might want to write for one of the more formal Guides at <ulink url="http://docs.fedoraproject.org/" /> - </para> - <para> - The guide will also be submitted for translation, so Fedora's users around the globe can benefit. See <ulink url="https://fedoraproject.org/wiki/L10N" /> for more information about the Fedora Localization project. - </para> - - </step> - - </procedure> - - - </section> - - <section> - <title>References</title> - <itemizedlist> - <listitem> - <para> - <ulink url="http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Documentation_Guide/index.html">Fedora Documentation Guide</ulink> - </para> - - </listitem> - - </itemizedlist> - - </section> - - -</section> - - |