Commit Graph

11 Commits

Author SHA1 Message Date
Marcus Schäfer
caf1b633fe
Update documentation in content and structure
This commit adds a documentation for the KIWI XML description.
In contrast to the former auto generated code from the XML
schema this document can now finally be used as a reference.
Along with that new chapter all auto generated and static
html content as been deleted. Also all helper scripts around
the proprietary oxygen tool and our schema doc generator
has been deleted. Auto generating this information does not
lead to a reference guide people can really work with.
As a consequence to these changes this commit also includes
some changes of the structure such that no information written
by other people in the past gets lost. This Fixes #1421
and Fixes #1474
2020-07-01 10:42:51 +02:00
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
be4aa08a4e
Fixed markup in contributing chapter
The headline of a subsection wrongly indicates a toplevel entry
2017-05-05 09:04:42 +02:00
Marcus Schäfer
a7a290c048
Update development and contribution chapter
Fix some minor inconsistencies due to latest code changes
with regards to py2 and py3 compatibility and also change
the style of the chapter to be more straight forward for
people who would like to contribute from scratch
2017-04-06 15:16:31 +02: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
a736d15e97
Update documentation
delete broken links to online ssh key blogs
2016-08-12 12:22:59 +02:00
Marcus Schäfer
5e250551e4
Update documentation
Cleanup structure of contribution guide
2016-07-07 09:57:36 +02:00
Marcus Schäfer
6e8d3fe607
Update documentation
Complete documentation about required C libraries which
needs to be installed prior to setting up the python
virtual development environment
2016-07-07 09:17:23 +02: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
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