summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPete Travis <immanetize@fedoraproject.org>2014-03-21 18:05:41 -0400
committerPete Travis <immanetize@fedoraproject.org>2014-03-21 18:05:41 -0400
commit19c68109ae5603506e2791815d903de55cf5e6ba (patch)
tree3c5d879206e693b1c497392c673af7b66d1b56e9
parent3a607a0156e28ee72d7f9a93ff5b3c1d927998ee (diff)
downloadfedora-cookbook-19c68109ae5603506e2791815d903de55cf5e6ba.tar.gz
fedora-cookbook-19c68109ae5603506e2791815d903de55cf5e6ba.tar.xz
fedora-cookbook-19c68109ae5603506e2791815d903de55cf5e6ba.zip
add a directory for examples, and a docbook example
-rw-r--r--en-US/examples/docbook.example72
1 files changed, 72 insertions, 0 deletions
diff --git a/en-US/examples/docbook.example b/en-US/examples/docbook.example
new file mode 100644
index 0000000..ecdd18b
--- /dev/null
+++ b/en-US/examples/docbook.example
@@ -0,0 +1,72 @@
+
+<?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 % BOOK_ENTITIES SYSTEM "Fedora_Cookbook.ent">
+ %BOOK_ENTITIES;
+]>
+<!-- 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 )
+-->
+
+<section id="NAME_OF_ARTICLE">
+ <title>Name Of Article</title>
+ <para>
+ Replace this text with an introduction to your tutorial.
+ </para>
+ <section id="NAME_OF_ARTICLE-ingredients">
+ <title>Required Ingredients</title>
+ <!-- list packages, services, other recipes etc that are required -->
+ <itemizedlist>
+ <listitem><para>
+ Required package group
+ </para></listitem>
+ <listitem><para>
+ <!--
+ An ingredient can be another recipe, use the section id.
+ This will automatically create a link to the referenced
+ section.
+ -->
+ <ulink xref="section-id" />
+ </para></listitem>
+ </itemizedlist>
+ </section>
+ <section id="NAME_OF_ARTICLE-directions">
+ <title>Directions</title>
+ <procedure>
+ <title>Creating a NAME_OF_ARTICLE</title>
+ <step><para>
+ Install required packages:
+ <screen>
+ <command>yum install PACKAGE_LIST</command>
+ </screen>
+ </para></step>
+ <step>
+ <para>
+ Activate required services:
+ <screen>
+ <command>systemctl start SERVICE_NAME</command>
+ <command>systemctl enable SERVICE_NAME</command>
+ </screen>
+ </para>
+ </step>
+ <step>
+ <para>
+ Edit some configuration file
+ </para>
+ <para>
+ You might want to explain further about that change, in another package.
+ </para>
+ </step>
+ <step><para>
+ You're getting the idea about the steps by now. Continue describing the process.
+ </para></step>
+ </procedure>
+ </section>
+</section>
+
+