Skip to content

Commit e42135c

Browse files
convert long banners to sidebars to avoid conflicts (#96)
1 parent 019b699 commit e42135c

File tree

44 files changed

+114
-1934
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+114
-1934
lines changed

docs/contributors/modules/docs-style/pages/formatting.adoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,21 +72,19 @@ You can also make a longer admonition block for any of the types listed above:
7272

7373
[source,adoc]
7474
----
75-
[CAUTION]
76-
====
75+
****
7776
This is a longer admonition with an ordered list:
7877
7978
. Step 1
8079
. Step 2
8180
. Step 3
82-
====
81+
****
8382
----
8483

85-
[CAUTION]
86-
====
84+
****
8785
This is a longer admonition with an ordered list:
8886
8987
. Step 1
9088
. Step 2
9189
. Step 3
92-
====
90+
****

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ Some notes on attributes
1515
1616
////
1717

18-
[NOTE]
19-
====
18+
****
2019
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:
2120
2221
* Develop new content quickly
@@ -25,7 +24,7 @@ This template will help you create a new docs page that shows the reader how to
2524
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.
2625
2726
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-
====
27+
****
2928

3029
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:
3130

docs/guides/modules/ROOT/partials/create-project/steps-up-to-pipeline.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,13 @@ image::guides:ROOT:create-project/what-project.png[Screenshot showing options to
1414

1515
. Give your project a descriptive name and then select btn:[Next: Set up a pipeline].
1616
+
17-
[TIP]
18-
====
17+
****
1918
**Project names** must meet the following requirements:
2019

2120
* Begin with a letter.
2221
* Be 3-40 characters long.
2322
* Contain only letters, numbers, or the following characters: `" - _ . : ! & + [ ] " ;`.
24-
====
23+
****
2524
+
2625
.Name your project
2726
image::guides:ROOT:create-project/enter-project-details.png[Screenshot showing options to enter project details]

docs/guides/modules/ROOT/partials/execution-resources/docker-arm-resource-table.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
[NOTE]
2-
====
1+
2+
****
33
*Arm on Docker* For credit and access information see the link:https://circleci.com/product/features/resource-classes/[Resource classes page]. Resource class access is dependent on your xref:guides:plans-pricing:plan-overview.adoc[Plan]
44
55
To find out which CircleCI Docker convenience images support Arm resource classes, you can refer to link:https://hub.docker.com/u/cimg[Docker hub]:
66
77
. Select the image (for example, `cimg/python`).
88
. Select the **tags** tab.
99
. View what is supported under **OS/ARCH** for the latest tags. For example, `cimg/python` has `linux/amd64` and `linux/arm64`, which means Arm **is** supported.
10-
====
10+
****
1111

1212
[.table.table-striped]
1313
[cols=5*, options="header", stripes=even]

docs/guides/modules/ROOT/partials/execution-resources/macos-resource-table.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@
2828
| icon:times[]
2929
|===
3030

31-
[WARNING]
32-
====
31+
****
3332
*We have deprecated support for all Intel-based macOS resources.*
3433
3534
The `macos.x86.medium.gen2` resource class was deprecated on June 28, 2024.
3635
3736
See our link:https://discuss.circleci.com/t/macos-intel-support-deprecation-in-january-2024/48718[announcement] for more details.
38-
====
37+
****
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
[NOTE]
2-
====
1+
****
32
To find your organization/user ID, select **Organization Settings** in the CircleCI web app side bar.
43
54
image::guides:ROOT:org-id.png[screenshot showing where to find your organization ID]
6-
====
5+
****

docs/guides/modules/ROOT/partials/notes/standalone-unsupported.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
[NOTE]
2-
====
1+
****
32
This feature **is supported** for orgs that use OAuth authentication.
43
54
Check your Organization slug at menu:Organization settings[Overview]. OAuth authenticated orgs are structured as follows:
@@ -12,4 +11,4 @@ This feature is **not supported** if your organization slug is in the following
1211
* `circleci/<UID>`.
1312
1413
For an overview of feature support, see the xref:guides:integration:version-control-system-integration-overview.adoc#feature-support-for-each-integration-type[VCS integration overview] page.
15-
====
14+
****

docs/guides/modules/ROOT/partials/runner/terms.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,14 @@ Your role within your org is determined differently depending on how you integra
1616
1717
* If your code is integrated with CircleCI via the GitHub App, GitLab, or Bitbucket Data Center, you can check roles by navigating to menu:Organization Settings[People]. Full details on roles and permissions are available in the xref:guides:permissions-authentication:roles-and-permissions-overview.adoc[Roles and permissions overview].
1818
19-
[TIP]
20-
====
19+
****
2120
To find out which GitHub integration you are using, head to the link:https://circleci.com/app[CircleCI web app], select your org, select **Organization Home** from the sidebar, and inspect the URL in your browser:
2221
2322
* This style of URL indicates you authenticated with the **GitHub App**: `https://app.circleci.com/organization/circleci/UTxCZDiJ9MLGLC8hR1ZDmg`
2423
* This style of URL indicates you authenticated with the **GitHub OAuth app**: `https://app.circleci.com/pipelines/github/<your GitHub username/organization name>`
2524
2625
For more information about the differences, see the link:https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps[GitHub docs comparison page].
27-
====
26+
****
2827

2928
--
3029
[.tab.runner-terms.CLI_installation]
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
[TIP]
2-
====
1+
****
32
To find out which GitHub integration type you have, check your Organization slug at menu:Organization settings[Overview]. OAuth authenticated orgs are structured as follows:
43
54
* `github/<your-org-name>` or `gh/<your-org-name>`
@@ -8,4 +7,4 @@ To find out which GitHub integration type you have, check your Organization slug
87
An organization slug for a GitHub App integration is in the following format:
98
109
* `circleci/<UID>`
11-
====
10+
****
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
[TIP]
2-
====
1+
****
32
**To find your project slug, follow these steps:**
43
54
. Head to the link:https://app.circleci.com/home[CircleCI web app] and select your org from the cards on your user homepage.
@@ -10,4 +9,4 @@
109
1110
* **GitHub App**: Project slug starts with `circleci` followed by UUIDs. For example, `circleci/34R3kN5RtfEE7v4sa4nWAU/4nYdoKGkb6RXn7JGt8SQtg`).
1211
* **GitHub OAuth app**: Project slug is human readable. For example, `github/circleci/circleci-demo-workflows`.
13-
====
12+
****

0 commit comments

Comments
 (0)