You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributors/modules/templates/pages/template-conceptual.adoc
+31-6Lines changed: 31 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,6 @@
4
4
:experimental:
5
5
6
6
////
7
-
Some notes on attributes:
8
7
:page-platform: drives the platform badges that you see in the info bar under the page title.
9
8
:page-description: is used for SEO and meta description. This should be a short description of the page content. Between 70 and 155 characters.
10
9
:experimental: allows access to asciidoc macros, more info here: https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/
@@ -34,7 +33,13 @@ image::guides:ROOT:arch.png[Diagram that includes flow from Repository and Apps
34
33
35
34
== Quickstart
36
35
37
-
Some readers will want to read through a full overview page to get a deep understanding of how a feature works, the full set of options available to them, any gotchas or limitations that might apply to them, and to find troubleshooting information. Other readers will want to get started with the feature or task right away and then return to the docs as needed. For those that want to get stuck in right away, it is a good idea to provide a quickstart section to help get them up and running with the basics in just a few steps.
36
+
Some readers will want to read through a full overview page to get a deep understanding of how a feature works, including:
37
+
38
+
* The full set of options available to them.
39
+
* Any gotchas or limitations that might apply to them.
40
+
* Find troubleshooting information.
41
+
42
+
Others will want to get started with the feature or task right away and then return to the docs as needed. For those that want to get stuck in right away, it is a good idea to provide a quickstart section.
38
43
39
44
You have two options here:
40
45
@@ -52,7 +57,7 @@ You have two options here:
52
57
53
58
Provide some detail on how the feature works 'under the hood' so readers can better conceptualise what they are doing. You might want to break this down into subsections.
54
59
55
-
=== This is a subsection title
60
+
=== Subsection title
56
61
57
62
Break up large blocks of text where possible to help make it easier to consume. You can use bullet lists:
58
63
@@ -62,7 +67,7 @@ Break up large blocks of text where possible to help make it easier to consume.
62
67
63
68
=== Using tables
64
69
65
-
This is the syntax for creating a table. This example has one heading row and one regular row. The table has three columns, and the third column is twice as wide as the first two columns. THe table has a title.
70
+
This section shows how to create a table. This example has one heading row and one regular row. The table has three columns, and the third column is twice as wide as the first two columns. THe table has a title.
Use AsciiDoc source blocks for code examples, with a title where possible. Use comments in the code block to explain what is happening:
96
101
97
-
.Add a line to exaplin what is in the code block
102
+
.Add a line to explain what is in the code block
98
103
[source,yaml]
99
104
----
100
105
version: 2.1
@@ -133,7 +138,7 @@ Use a short section in bold at the start of the admonition to try to attract the
133
138
If you need a longer admonition you can use a sidebar block:
134
139
135
140
****
136
-
This is a longer admonition with an ordered list:
141
+
This longer admonition includes an ordered list:
137
142
138
143
. Step 1
139
144
. Step 2
@@ -142,6 +147,26 @@ This is a longer admonition with an ordered list:
142
147
143
148
For more information, see xref:docs-style:formatting.adoc#using-notes-tips-cautions-warnings[the CircleCI style guide].
144
149
150
+
=== Use tabs to show different options
151
+
152
+
Use tabs to show different options:
153
+
154
+
[tabs]
155
+
====
156
+
Tab A::
157
+
+
158
+
--
159
+
Content for Tab A
160
+
--
161
+
Tab B::
162
+
+
163
+
--
164
+
Content for Tab B
165
+
--
166
+
====
167
+
168
+
Use tabs to show options for a single task when there are multiple ways to achieve the same outcome, or to show how to configure a thing in multiple ways.
169
+
145
170
== Limitations
146
171
147
172
If there are any limitations to the feature or task, list them here.
Copy file name to clipboardExpand all lines: docs/contributors/modules/templates/pages/template-how-to.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ Break up large blocks of text where possible to help make it easier to consume.
64
64
65
65
=== 1.2. Using tables
66
66
67
-
This is the syntax for creating a table. This example has one heading row and one regular row. The table has three columns, and the third column is twice as wide as the first two columns. THe table has a title.
67
+
This section shows how to create a table. This example has one heading row and one regular row. The table has three columns, and the third column is twice as wide as the first two columns. THe table has a title.
68
68
69
69
.This is a table
70
70
[cols="1,1,2"]
@@ -98,7 +98,7 @@ Whenever possible, the how-to guide should provide examples that cover link:http
98
98
99
99
Use AsciiDoc source blocks for code examples, with a title where possible. Use comments in the code block to explain what is happening:
100
100
101
-
.Add a line to exaplin what is in the code block
101
+
.Add a line to explain what is in the code block
102
102
[source,yaml]
103
103
----
104
104
version: 2.1
@@ -137,7 +137,7 @@ Use a short section in bold at the start of the admonition to try to attract the
137
137
If you need a longer admonition you can use a sidebar block:
138
138
139
139
****
140
-
This is a longer admonition with an ordered list:
140
+
This admonition is longer and includes an ordered list:
141
141
142
142
. Step 1
143
143
. Step 2
@@ -177,7 +177,7 @@ Content for Tab B
177
177
--
178
178
====
179
179
180
-
We often use tabs to show different options for a single task when there are multiple ways to achieve the same outcome, or, for example to show how to configure a thing in multiple execution environments.
180
+
Use tabs to show options for a single task when there are multiple ways to achieve the same outcome, orto show how to configure a thing in multiple ways.
0 commit comments