CONTRIBUTING_GUIDE_FOR_WIKI.adoc

Table of Contents

• Wiki Contributions
  • Text styles
  • Titles
  • Lists
  • Tables
  • Source Code

Wiki Contributions

Our wikis are written in the so called AsciiDoc format. Check the AsciiDoc cheatsheet and the AsciiDoc quick reference for more information. Knowing the following basic features should allow you to convert your Word documents into the Wiki friendly AsciiDoc format.

It is mandatory to follow the code of conduct that must be present in the root of every OSS or private project as CODE_OF_CONDUCT.asciidoc or CODE_OF_CONDUCT.md.

Text styles

Italic Text

_Italic Text_

Bold Text

*Bold Text*

Mono Spaced Text

+Mono Spaced Text+

Text in ^Superscript

Text in ^Superscript^

Text in _Subscript

Text in ~Subscript~

Titles

A title can be initiated like this:

= Level 1 header
== Level 2 header
== Level 3 header
...

Lists

Ordered and unordered lists can be created like this:

Ordered list:
. Item 1
. Item 2
. Item 3
. ...

Unordered list:
* Item 1
* Item 2
* Item 3
* ...

Tables

The following example shows how a table can be created. Note that the header flag is optional.

[options="header"]
|===
|Header 1|Header 2| Header 3
|  Item 1|  Item 2|   Item 3
|     ...|     ...|      ...
|===

Source Code

If you want to show off some code examples, you can use the code block:

[source]
 ----
 Some source code
 ----

You can also specify which script language is used. This will allow GitHUb to use a matching color scheme. Therefore, just type in the type of code used:

[source, bash]

or

[source, java]