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
* check all snippets partials and images exist and copy across all pages
* migrate all pages and make mapping table
* remove old docs
* convert page-platform and remove frontmatter
* remove page-layout
* fix image block references
* fix include
* update includes
* fix server includes
* fix xrefs as far as script can
* remove # when no section anchor needed
* fix xrefs
* fix image blocks and missing index
* fix some xrefs
* fix double file ext
* fix some xrefs
* fix more xrefs
* fix xrefs
* fix xrefs
* create server-admin for latest version
* fix xrefs
* fix xrefs
* fix xrefs
* fix partial paths
* fix paths and xrefs
* fix paths and xrefs
* fix paths and xrefs
* fix xrefs
* add missing sublanding pages
* fix xrefs and add missing pages
* fix xref and introduce missing pages
* fix xrefs
* remove server 4.6 from latest
* remove 4.5 server content from latest
* remove server 4.4 from latest
* remove 4.3 version from latest
* remove 4.1 and 4.2
* upper case Server
* add some content to landing page
* fix warning about unset attribute
Copy file name to clipboardExpand all lines: docs/contributors/modules/templates/pages/template-how-to.adoc
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Some notes on attributes
16
16
////
17
17
18
18
[NOTE]
19
-
****
19
+
====
20
20
This template will help you create a new docs page that shows the reader how to carry out a task and accomplish a specific goal with CircleCI. Content templates help you to:
21
21
22
22
* Develop new content quickly
@@ -25,7 +25,7 @@ This template will help you create a new docs page that shows the reader how to
25
25
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 page template link:https://github.com/circleci/circleci-docs/blob/master/jekyll/_cci2/template/template-how-to.adoc?plain=1[here]. There is additional detail in the comments.
26
26
27
27
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.
28
-
****
28
+
====
29
29
30
30
In a how-to guide, include one or two opening paragraphs. The opening paragraph should be used to briefly describe to the reader what the reader will do using this guide, and what the outcomes are when they successfully finish the task. The information in the opening paragraph should help answer the following questions for the reader:
31
31
@@ -34,7 +34,7 @@ In a how-to guide, include one or two opening paragraphs. The opening paragraph
34
34
35
35
TIP: Since the reader will usually want to quickly get to the task at hand, keep the introduction succinct.
36
36
37
-
TIP: Consider providing a link to an xref:template-conceptual.adoc#[overview or conceptual doc], should the reader be interested in more explanatory or background information regarding the feature or task.
37
+
TIP: Consider providing a link to an xref:template-conceptual.adoc[overview or conceptual doc], should the reader be interested in more explanatory or background information regarding the feature or task.
38
38
39
39
[#prerequisites]
40
40
== Prerequisites
@@ -48,7 +48,7 @@ This is the first subsection in the how-to guide. List any prerequisites that th
48
48
* Roles and permissions
49
49
* Skills/knowledge
50
50
// This renders as a nested item
51
-
** Link to any helpful documentation or pages that they can refer to, for example, "For more information on how test splitting works, refer to the xref:guides:optimize:parallelism-faster-jobs.adoc#[Test splitting and parallelism] page."
51
+
** Link to any helpful documentation or pages that they can refer to, for example, "For more information on how test splitting works, refer to the xref:guides:optimize:parallelism-faster-jobs.adoc[Test splitting and parallelism] page."
52
52
* Any other dependencies
53
53
54
54
Sometimes, there may be topics to know or tasks to complete that are _helpful_ in order to successfully finish the how-to guide, but do not necessarily have a negative impact on the user's flow if they only do those as they go along. For example, you may include generating an API token in the how-to steps itself, rather than listing it as a strict prerequisite. Use your best judgment to decide whether to add such a requirement as a prerequisite or as a step that is part of the how-to.
@@ -70,8 +70,8 @@ In a how-to guide, you might walk the reader through an example scenario. Exampl
70
70
71
71
Subsections can be used to break steps into logical sub-parts as needed. Level 2 section titles (`===`) should also be ordered:
72
72
73
-
* If the document comprises multiple smaller how-to guide, use numbers in the Level 2 titles. (As an example, see the xref:guides:config-policies:manage-contexts-with-config-policies.adoc#[Manage contexts with config policies] guide)
74
-
* Otherwise, consider using lowercase letters. (As an example, see xref:guides:optimize:use-the-circleci-cli-to-split-tests.adoc#[Use the CircleCI CLI to split tests])
73
+
* If the document comprises multiple smaller how-to guide, use numbers in the Level 2 titles. (As an example, see the xref:guides:config-policies:manage-contexts-with-config-policies.adoc[Manage contexts with config policies] guide)
74
+
* Otherwise, consider using lowercase letters. (As an example, see xref:guides:optimize:use-the-circleci-cli-to-split-tests.adoc[Use the CircleCI CLI to split tests])
75
75
76
76
Break up large blocks of text where possible to help make it easier to consume. You can use bullet lists:
Copy file name to clipboardExpand all lines: docs/contributors/modules/templates/pages/template-tutorial.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
@@ -30,7 +30,7 @@ Contributors from within CircleCI can also consider setting up a local developme
30
30
[#introduction]
31
31
== Introduction
32
32
33
-
Use the introduction to explain what the reader is going to achieve through following the tutorial. Link back to the _conceptual_ page that accompanies the tutorial, to illustrate this here is a link to the xref:template-conceptual.adoc#[template for conceptual pages]. If possible provide a demo or example. The tutorial should ideally be written to accompany a public/open source example that any reader can use, but the tutorial should also be able to accommodate a reader’s own project.
33
+
Use the introduction to explain what the reader is going to achieve through following the tutorial. Link back to the _conceptual_ page that accompanies the tutorial, to illustrate this here is a link to the xref:template-conceptual.adoc[template for conceptual pages]. If possible provide a demo or example. The tutorial should ideally be written to accompany a public/open source example that any reader can use, but the tutorial should also be able to accommodate a reader’s own project.
0 commit comments