Commit Graph

31 Commits

Author SHA1 Message Date
Marcus Schäfer
2046220c07 Refactor documentation layout and structure
The current design of the documentation does not allow for
continous improvement and development. It's missing a basic
structure and concept for documenting step-by-step workflows
and generic explanations.
2017-05-10 16:32:23 +02:00
Marcus Schäfer
1c3524ee13
Update distribution support status
Add information that Fedora systems are now supported as well
2017-02-24 15:08:09 +01:00
Marcus Schäfer
f13a7918ea
Added extension documentation 2016-12-01 11:58:38 +01:00
David Cassany
df4e7b7278 Documentation workflow review 2016-11-21 18:32:51 +01:00
Marcus Schäfer
7dfa9ee007 Integrate schema documentation into doc process
The schema documentation is auto generated via the schema_parser
helper tool. The tox doc target now also generates schema docs
Fixes #53
2016-09-12 16:31:48 +02:00
Marcus Schäfer
93b8786364
Update documentation
Move information about legacy kiwi in its own chapter
2016-08-15 11:41:37 +02:00
Marcus Schäfer
b1d1e2208e
Added integration build test link to doc index 2016-07-13 14:31:56 +02:00
Marcus Schäfer
1ea8b0ed6a
Update Documentation
Update state of supported distributions
2016-06-27 17:28:44 +02:00
Marcus Schäfer
5db527d40c
Added article about self contained building
The article describes how to make use of the dice
project to control and maintain image build processes
in a contained environment
2016-06-21 16:30:22 +02:00
Thomas Schraitle
db6c64cfe7 Differentiate between Python 2.7 and 3 in doc 2016-06-14 09:34:24 +02:00
Marcus Schäfer
e1c6fb3716
Split quickstart into two parts
Split the quickstart information into a development and
a user part
2016-05-21 21:45:08 +02:00
Marcus Schäfer
99cf51394b
Added dropped features information for lxc 2016-05-10 16:17:31 +02:00
Marcus Schäfer
810ad378dd Merge pull request #57 from SUSE/version2doc
Integrate version string from placeholder
2016-04-25 12:14:18 +02:00
Thomas Schraitle
63add3325c Integrate version string from placeholder
Use |version| placeholder, no bumpversion etc. is needed.
Actually, it's taken from conf.py
2016-04-22 13:31:54 +02:00
Thomas Schraitle
8733afc8f2 Spell checking doc and extended word list 2016-04-22 09:52:49 +02:00
Marcus Schäfer
2c31d70ecb
Fixed documentation link references
Use redirected target and fix broken targets according to
link check on make build
2016-04-21 12:07:09 +02:00
Marcus Schäfer
ec60cc58a8
Fixed typo in documentation
Missing question mark at end of sentence
2016-04-21 11:51:36 +02:00
Marcus Schäfer
4b1c59624c
Fixed typo 2016-04-21 11:46:18 +02:00
Marcus Schäfer
785b3a0447
Added Legacy KIWI vs. Next Generation chapter 2016-04-21 11:32:21 +02:00
Thomas Schraitle
0b1460aa49 More substantial changes of the doc
* Overall: try to be more consistent
* index.rst
  * Move "Supported Distributions" and "Dropped Features" sections
* Quick Start:
  * Add abstract
  * Add note about automatic link creation
  * Move "example appliance description" sections and subsections
    further down
  * Streamlined "Contributing" section
  * Corrected titles and distinguish more between descriptive and
    procedural
2016-04-20 17:01:36 +02:00
Thomas Schraitle
a15e1cf0e0 Move Motivation section from quickstart to index 2016-04-20 15:20:56 +02:00
Thomas Schraitle
30ee0d2291 Add QuickStart Guide and improve documentation
* Added Quick Start Guide, taken from README.md
* Improve index/main file:
  * Shortend main entry page
  * Make more headings
  * Add feature highlights to draw attention
  * Add sidebar with important KIWI links
  * Use ordered list of KIWI concept (prep and creation step)
2016-04-20 11:35:32 +02:00
Marcus Schäfer
63253068ca
Fixed documentation linkcheck results 2016-04-18 17:12:39 +02:00
Marcus Schäfer
fb805ee100
Update documentation entry page 2016-04-18 16:57:17 +02:00
Marcus Schäfer
9be138acc8 Update api documentation setup 2016-04-08 16:10:15 +02:00
Marcus Schäfer
b2552121f8 Create Initial autodoc structure
Called 'sphinx-apidoc -o source/api ../kiwi'
2016-04-08 16:10:15 +02:00
Marcus Schäfer
467d3ee54c Move manual page documentation in subdirectory
Separate api documentation from manual pages
2016-04-08 16:10:15 +02:00
Marcus Schäfer
8d738b31d1
Added man page for result bundle command 2016-02-15 00:14:22 +01:00
Marcus Schäfer
e132246b35
Added man page templates for all commands 2016-02-06 13:55:10 +01:00
Marcus Schäfer
b6945bb7e6
Added man page templates
Added template for master page and result_list
2016-02-05 12:06:40 +01:00
Marcus Schäfer
4c4ae90aff
Added initial sphinx documentation structure
The documentation will cover kiwi manual pages. more detailed
documentation will be written and maintained in colaboration
with the documentation department
2016-02-05 11:08:03 +01:00