Commit Graph

18 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
15f211f9d1 Add documentation hint for multipython package 2017-03-13 09:48:18 +01:00
Marcus Schäfer
6a9abc77b6
Adapt documentation to rtd schema
replace topic node used for abstract by a hint. This results
in a color box for the abstract which looks better than what
rtd does with simple topics
2016-12-06 18:55:59 +01:00
Marcus Schäfer
1ea8b0ed6a
Update Documentation
Update state of supported distributions
2016-06-27 17:28:44 +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
4e6c8977bb
Update quickstart documentation
kiwi can also be used as a module in other python3 projects.
An example how to do that has been added to the quickstart
2016-05-24 10:49:09 +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
Thomas Schraitle
3a225a92f4 Add requirements section in Quick Start
* Describe what KIWI needs to run, further requirements, and for development
* Introduce 'ghkiwi' as prefix in "extlinks" to shorten external links and
  to make linking to KIWI's GitHub repository more intuitive and consistent.
  For example, the string :ghkiwi:`tox.ini` is replaced with
  https://github.com/SUSE/kiwi/blob/master/tox.ini
2016-05-05 13:19:25 +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
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
bb5ae9f5e6 Remove useless substitutions (placeholders) 2016-04-20 15:22:15 +02:00
Thomas Schraitle
a15e1cf0e0 Move Motivation section from quickstart to index 2016-04-20 15:20:56 +02:00
Thomas Schraitle
4aad113d98 Correct heading and remove build status 2016-04-20 12:39:55 +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