From Fedora Project Wiki
m (moved Publishing draft documentation to Publishing draft documentation using Publican: clarifying the title) |
m (header) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{header|docs}} | |||
{{admon/note | This page is obsolete | Come back to [[Docs Project]] }} | |||
When your book or article is ready to present in draft form on docs.fedoraproject.org, make the following changes before you publish: | When your book or article is ready to present in draft form on docs.fedoraproject.org, make the following changes before you publish: | ||
| Line 11: | Line 13: | ||
<productnumber></productnumber> | <productnumber></productnumber> | ||
</pre> | </pre> | ||
Optionally, if you plan to release the document for a particular Fedora release, include the Fedora release number in the the '''<edition>''' tag. For example, if you plan to release the book for Fedora 14, you would set: | |||
<pre> | |||
<edition>14.0.1</edition> | |||
</pre> | |||
Here, 14.0.1 signifies Fedora 14, edition 0.1. | |||
<!-- when we automate publishing, we'll need to modify the publican config file because of this... --> | |||
==Publican.cfg file== | ==Publican.cfg file== | ||
| Line 21: | Line 33: | ||
</pre> | </pre> | ||
[[Category:Docs Project]] | ==<Book_Name>.xml== | ||
* For example: '''Installation_Guide.xml''' | |||
* Change '''<book>''' to '''<book status="draft">''' | |||
This will add the red '''DRAFT''' watermark to the document for draft publication. | |||
[[Category:Docs Project process]] | |||
Latest revision as of 19:10, 6 June 2019
This page is obsolete
Come back to Docs Project
Come back to Docs Project
When your book or article is ready to present in draft form on docs.fedoraproject.org, make the following changes before you publish:
Book_Info.xml (or Article_Info.xml)
- Change the <productname> tag to Fedora Draft Documentation
- Remove the contents of the <productnumber> tag and leave it empty.
The relevant lines should now look like this:
<productname>Fedora Draft Documentation</productname> <productnumber></productnumber>
Optionally, if you plan to release the document for a particular Fedora release, include the Fedora release number in the the <edition> tag. For example, if you plan to release the book for Fedora 14, you would set:
<edition>14.0.1</edition>
Here, 14.0.1 signifies Fedora 14, edition 0.1.
Publican.cfg file
- Add the following lines to the book or article's publican.cfg file:
version: 0.1 web_version_label: UNUSED
<Book_Name>.xml
- For example: Installation_Guide.xml
- Change <book> to <book status="draft">
This will add the red DRAFT watermark to the document for draft publication.