Skip to content

Commit 05f137b

Browse files
committed
fix lint errors
1 parent b5c2eed commit 05f137b

File tree

2 files changed

+35
-10
lines changed

2 files changed

+35
-10
lines changed

docs/contributors/modules/templates/pages/template-conceptual.adoc

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
:experimental:
55

66
////
7-
Some notes on attributes:
87
:page-platform: drives the platform badges that you see in the info bar under the page title.
98
:page-description: is used for SEO and meta description. This should be a short description of the page content. Between 70 and 155 characters.
109
: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
3433

3534
== Quickstart
3635

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.
3843

3944
You have two options here:
4045

@@ -52,7 +57,7 @@ You have two options here:
5257

5358
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.
5459

55-
=== This is a subsection title
60+
=== Subsection title
5661

5762
Break up large blocks of text where possible to help make it easier to consume. You can use bullet lists:
5863

@@ -62,7 +67,7 @@ Break up large blocks of text where possible to help make it easier to consume.
6267

6368
=== Using tables
6469

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.
6671

6772
.This is a table
6873
[cols="1,1,2"]
@@ -94,7 +99,7 @@ xref:guides:about-circleci:about-circleci.adoc#learn-more[About CircleCI]
9499

95100
Use AsciiDoc source blocks for code examples, with a title where possible. Use comments in the code block to explain what is happening:
96101

97-
.Add a line to exaplin what is in the code block
102+
.Add a line to explain what is in the code block
98103
[source,yaml]
99104
----
100105
version: 2.1
@@ -133,7 +138,7 @@ Use a short section in bold at the start of the admonition to try to attract the
133138
If you need a longer admonition you can use a sidebar block:
134139

135140
****
136-
This is a longer admonition with an ordered list:
141+
This longer admonition includes an ordered list:
137142
138143
. Step 1
139144
. Step 2
@@ -142,6 +147,26 @@ This is a longer admonition with an ordered list:
142147

143148
For more information, see xref:docs-style:formatting.adoc#using-notes-tips-cautions-warnings[the CircleCI style guide].
144149

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+
145170
== Limitations
146171

147172
If there are any limitations to the feature or task, list them here.

docs/contributors/modules/templates/pages/template-how-to.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Break up large blocks of text where possible to help make it easier to consume.
6464

6565
=== 1.2. Using tables
6666

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.
6868

6969
.This is a table
7070
[cols="1,1,2"]
@@ -98,7 +98,7 @@ Whenever possible, the how-to guide should provide examples that cover link:http
9898

9999
Use AsciiDoc source blocks for code examples, with a title where possible. Use comments in the code block to explain what is happening:
100100

101-
.Add a line to exaplin what is in the code block
101+
.Add a line to explain what is in the code block
102102
[source,yaml]
103103
----
104104
version: 2.1
@@ -137,7 +137,7 @@ Use a short section in bold at the start of the admonition to try to attract the
137137
If you need a longer admonition you can use a sidebar block:
138138

139139
****
140-
This is a longer admonition with an ordered list:
140+
This admonition is longer and includes an ordered list:
141141
142142
. Step 1
143143
. Step 2
@@ -177,7 +177,7 @@ Content for Tab B
177177
--
178178
====
179179

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, or to show how to configure a thing in multiple ways.
181181

182182
== Conclusion
183183

0 commit comments

Comments
 (0)