//TODO: The following block must remain commented out, but add your name to the authors list in whatever format you want to be publicly visible in the openshift-docs repo.
//TODO: When you are finished writing your tutorial, delete everything below this line.
// These are just some basic syntax examples so you can copy and paste easily.
== AsciiDoc Syntax Basics
For more information, refer to link:https://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc Writer's Guide]
=== Headings
To add a heading, use equals signs at the beginning of the line:
[source]
----
== Second level heading text
=== Third level heading text
----
Up to 5 levels of heading are available, but this usually won't be required.
.Block element heading
You can also add a small header to a block element by adding a full-stop at the start of the line. Do not add a space or this will become an ordered list item.
[source]
----
.Block element heading
----
=== Paragraphs, links, and inline elements
A paragraph is just a plain line of text like this.
A single line break will be rendered as part of the same paragraph.
A double line break will be rendered as a separate paragraph.
You can _emphasize_ or *strengthen* text in a paragraph, or add a link to a link:http://www.redhat.com[Red Hat website].
----
Link to non-Red Hat websites if necessary, but remember they won't necessarily open in a new tab, and might lead users away from your document.
=== Lists
Unordered lists use asterisks followed by a space:
.My unordered list
* First level list item
** Use multiple asterisks to indent second level list items
* Another first level list item
[source]
----
.My unordered list
* First level list item
** Use multiple asterisks to indent second level list items
* Another first level list item
----
Ordered lists use full stops followed by a space:
.My ordered list
. Step one
.. Step 1.a.
. Step two
[source]
----
.My ordered list
. Step one
.. Step 1.a.
. Step two
----
You can also use two colons to get a term and definition list:
.Important definitions
term:: definition goes here
cat:: A cute and cuddly carnivorous companion animal with hidden foot knives.
dog:: A cute and cuddly omnivorous companion animal with clearly visible foot knives.
[source]
----
.Important definitions
term:: definition goes here
cat:: A cute and cuddly carnivorous companion animal with hidden foot knives.
dog:: A cute and cuddly omnivorous companion animal with clearly visible foot knives.
----
=== Code
You can use `backticks` to indicate a literal value inline, but for commands, code, and terminal output you want a code block:
[source,terminal]
----
$ rosa version
1.2.23
I: There is a newer release version '1.2.26', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
----
[source]
------
[source,terminal]
----
$ rosa version
1.2.23
I: There is a newer release version '1.2.26', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
----
------
The `[source]` part ahead of the code block specifies the kind of code in the block, and enables syntax highlighting based on the language provided after the comma.
Tables use a combination of pipes and equals signs for their basic structure. If you want to include more complex content, you can add an `a` before the pipe indicating the start of the complex cell, and use other kinds of asciidoc syntax in that cell as required.
Place the image you want to use in the `cloud_experts_tutorials/images` sub-directory, and use only the file name in the `image::` block (not the relative path). For accessibility support, add a title for the image and describe the contents of the image. We recommend using PNG and SVG image formats.
.The perspectives menu in OpenShift Web Console
image::web_console_perspectives.png[The perspectives menu in OpenShift Web Console showing the Developer and Administrator persoectives]
You can chain multiple block-level asciidoc elements together with the plus sign. You'll most often do this with steps and code blocks, so that the code block stays at the same indent level as the instruction text, for example:
. Open a terminal and log in to the ROSA CLI using your personal token: