Skip to content

Commit b5c2eed

Browse files
committed
refresh of how to and conceptual template
1 parent d3df8d3 commit b5c2eed

File tree

2 files changed

+136
-90
lines changed

2 files changed

+136
-90
lines changed

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

Lines changed: 64 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,57 @@
11
= Page title
22
:page-platform: Cloud, Server v4+
3-
:page-description: A short page description goes here
3+
:page-description: A short page description goes here max 155 characters.
44
:experimental:
55

66
////
7-
Some notes on attributes
8-
7+
Some notes on attributes:
8+
:page-platform: drives the platform badges that you see in the info bar under the page title.
9+
:page-description: is used for SEO and meta description. This should be a short description of the page content. Between 70 and 155 characters.
910
:experimental: allows access to asciidoc macros, more info here: https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/
10-
1111
////
1212

13+
****
1314
This template will help you create a new docs page to provide **conceptual** information about a feature or task in CircleCI. Content templates help you to:
1415
1516
* Develop new content quickly
16-
* Ensure your page conforms to the style guide
17-
18-
To use this template make a copy and place it in the `_cci2` directory. The filename should match the page title. Look at the source file for this link:https://github.com/circleci/circleci-docs/blob/master/jekyll/_cci2/templates/template-conceptual.adoc?plain=1[page template here]. There is additional detail in the comments.
17+
* Ensure your page conforms to the CircleCI docs style guide
1918
20-
The opening paragraph should be used to succinctly explain to the reader what value the feature/task provides and what use cases it supports. If possible display the use cases in a bullet list.
19+
The file name for the new page should exactly match the page title. Look at the source file for this page template link:https://github.com/circleci/circleci-docs/blob/main/docs/contributors/modules/templates/pages/template-how-to.adoc[here].
20+
****
2121

22-
Contributors from within CircleCI can also consider setting up a local development environment to preview changes before pushing. Ping one of the Developer Resources and Engineering team (DRE) for more information.
22+
The opening paragraph should be used to succinctly explain to the reader what value the concept or feature provides and what use cases it supports. If possible, display the use cases in a bullet list.
2323

24-
[#introduction]
2524
== Introduction
2625

2726
Use the introduction to explain more about the feature/task, what it is for, why it is useful, and the wider context. Try to answer the following questions for the reader:
2827

29-
* What’s in it for me?
30-
* How does this feature / task help me create more value?
28+
* Why should I be interested in this task?
29+
* How will this task help me create more value in my usage of CircleCI?
3130

32-
You might want to include an image or diagram here to help illustrate the concept. The docs team can work with you to help create helpful image to support explanatory information:
31+
You might want to include an image or diagram here to help illustrate more complex concepts. The docs team can work with you to help create helpful image to support explanatory information:
3332

3433
image::guides:ROOT:arch.png[Diagram that includes flow from Repository and Apps to CircleCI API, from CircleCI API to Orchestration, from Orchestration to Execution, and from Execution to Deployment.]
3534

36-
[#quickstart]
3735
== Quickstart
3836

39-
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 the latter it is a good idea to provide a quickstart section to help get the reader up and running with the basics in just a few steps.
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.
4038

41-
Point readers to a how-to guide or tutorial in this quickstart section.
39+
You have two options here:
4240

43-
Alternatively, if a separate guide doesn't exist yet, provide some numbered steps here to get set up:
41+
* Point readers to a how-to guide if available.
42+
* Provide minimal ordered steps to get set up:
4443

4544
// The following will render as a numbered list
4645

47-
. Provide some steps here
48-
. To get started with this feature
49-
. Inlcude a step for every action
50-
. Try not to skip steps or assume readers will know, for example, which button to click
46+
. Provide some steps here.
47+
. To get started with this feature.
48+
. Include a step for every action.
49+
. Do not skip steps or assume readers will know, for example, which button to select
5150

52-
[#how-the-feature-works]
5351
== How the feature works
5452

55-
Consider providing 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.
53+
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.
5654

57-
[#this-is-a-subsection-title]
5855
=== This is a subsection title
5956

6057
Break up large blocks of text where possible to help make it easier to consume. You can use bullet lists:
@@ -63,16 +60,14 @@ Break up large blocks of text where possible to help make it easier to consume.
6360
* Item 2
6461
* Item 3
6562

66-
[#using-tables]
6763
=== Using tables
6864

69-
This is the syntax for creating a table. This example has one heading row and one normal row. The table has three columns
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.
7066

71-
[cols=3*, options="header"]
67+
.This is a table
68+
[cols="1,1,2"]
7269
|===
73-
|Header text column 1
74-
|Header text column 2
75-
|Header text column 3
70+
|Header text column 1 |Header text column 2 |Header text column 3
7671

7772
|Text for row 1 column 1
7873
|Text for row 1 column 2
@@ -81,7 +76,6 @@ This is the syntax for creating a table. This example has one heading row and on
8176

8277
For a full description of the options available, including merging cells, and cell formatting, see the link:https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/[Asciidoctor docs].
8378

84-
[#links-and-cross-references]
8579
=== Links and cross references
8680

8781
To link out to content outside of the docs use a link:
@@ -92,24 +86,24 @@ To link to another page within the docs use a cross reference:
9286

9387
xref:guides:about-circleci:about-circleci.adoc[About CircleCI]
9488

95-
Notice the `#` at the end of the filename. You can place the subsection anchor there if you want to link to a subsection:
89+
You can place the subsection anchor using a hash symbol if you want to link to a subsection:
9690

9791
xref:guides:about-circleci:about-circleci.adoc#learn-more[About CircleCI]
9892

99-
[#code-examples]
10093
=== Code examples
10194

102-
Use asciidoc source blocks for code:
95+
Use AsciiDoc source blocks for code examples, with a title where possible. Use comments in the code block to explain what is happening:
10396

97+
.Add a line to exaplin what is in the code block
10498
[source,yaml]
10599
----
106100
version: 2.1
107101
jobs:
108102
build:
109-
docker:
103+
docker: # use a docker image to run the job
110104
- image: cimg/base:2021.04
111105
steps:
112-
- checkout
106+
- checkout # check out the code in the project directory
113107
- run:
114108
name: The First Step
115109
command: |
@@ -122,22 +116,52 @@ jobs:
122116
echo '^^^The files in your repo^^^'
123117
----
124118

125-
[#banners]
126119
=== Banners
127120

128-
In technical writing we use _admonitions_ to create blocks of content that stand out from the main flow of text. Outside the docs team we usually refer to these as _banners_. Currently we have the option to include notes, cautions, and warnings, as follows:
121+
Use _admonitions_ to create blocks of content that stand out from the main flow of text. Use admonitions sparingly as they can be distracting or lose emphasis if they appear too often. Currently we have the option to include tips notes, cautions, and warnings, as follows:
122+
123+
TIP: **Need to add a tip?** This is how to do it
129124

130125
NOTE: **Need to add a note?** This is how to do it
131126

132127
CAUTION: **Need to add a caution?** This is how to do it
133128

134129
WARNING: **Need to add a warning?** This is how to do it
135130

136-
We try to use a short section in bold at the start of the admonition to try to attract the readers attention.
131+
Use a short section in bold at the start of the admonition to try to attract the readers attention.
132+
133+
If you need a longer admonition you can use a sidebar block:
134+
135+
****
136+
This is a longer admonition with an ordered list:
137+
138+
. Step 1
139+
. Step 2
140+
. Step 3
141+
****
137142

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

140-
[#next-steps]
145+
== Limitations
146+
147+
If there are any limitations to the feature or task, list them here.
148+
149+
== Troubleshooting
150+
151+
If there is troubleshooting information for the feature or task, list it here. Use a question and answer format to make it easier to read. If a troubleshooting step applies to an error message, include the error message in the question to help people to find the solution.
152+
153+
=== Error description
154+
155+
Place the solution or debugging steps here after the error description.
156+
157+
== Frequently asked questions
158+
159+
If there are any frequently asked questions about the feature or task, list them here. Use a question and answer format to make it easier to read.
160+
161+
=== Question?
162+
163+
Place the answer here after the question.
164+
141165
== Next steps
142166

143167
// Here you can inlude links to other pages in docs or the blog etc. where the reader should head next.

0 commit comments

Comments
 (0)