Skip to content

Commit 019b699

Browse files
migrate all content (#94)
* 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
1 parent 965927e commit 019b699

File tree

356 files changed

+4209
-3828
lines changed

Some content is hidden

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

356 files changed

+4209
-3828
lines changed
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
= Docs Style Guide
2-
3-
The pages in this section make up the CircleCI documentation style guide.
1+
= Docs style guide

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
+
99
[source,adoc]
1010
----
11-
link:/docs/github-integration#user-keys-and-deploy-keys[User Keys and Deploy Keys]
11+
xref:guides:integration:github-integration.adoc#user-keys-and-deploy-keys[User Keys and Deploy Keys]
1212
----
1313

1414
* The **.md** equivalent would be to use a link:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
= Content Templates
1+
= Templates

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,6 @@ For more information, see xref:docs-style:formatting.adoc#using-notes-tips-cauti
146146
== Next steps
147147

148148
// Here you can inlude links to other pages in docs or the blog etc. where the reader should head next.
149-
* xref:template-tutorial.adoc#[Tutorial template]
149+
* xref:template-tutorial.adoc[Tutorial template]
150150
* xref:guides:about-circleci:benefits-of-circleci.adoc[Benefits of CircleCI]
151-
* xref:guides:about-circleci:concepts.adoc#[CircleCI concepts]
151+
* xref:guides:about-circleci:concepts.adoc[CircleCI concepts]

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Some notes on attributes
1616
////
1717

1818
[NOTE]
19-
****
19+
====
2020
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:
2121
2222
* Develop new content quickly
@@ -25,7 +25,7 @@ This template will help you create a new docs page that shows the reader how to
2525
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.
2626
2727
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+
====
2929

3030
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:
3131

@@ -34,7 +34,7 @@ In a how-to guide, include one or two opening paragraphs. The opening paragraph
3434

3535
TIP: Since the reader will usually want to quickly get to the task at hand, keep the introduction succinct.
3636

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

3939
[#prerequisites]
4040
== Prerequisites
@@ -48,7 +48,7 @@ This is the first subsection in the how-to guide. List any prerequisites that th
4848
* Roles and permissions
4949
* Skills/knowledge
5050
// 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."
5252
* Any other dependencies
5353

5454
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
7070

7171
Subsections can be used to break steps into logical sub-parts as needed. Level 2 section titles (`===`) should also be ordered:
7272

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])
7575

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

@@ -107,7 +107,7 @@ link:https://circleci.com/[CircleCI website]
107107

108108
To link to another page within the docs use a cross reference:
109109

110-
xref:guides:about-circleci:about-circleci.adoc#[About CircleCI]
110+
xref:guides:about-circleci:about-circleci.adoc[About CircleCI]
111111

112112
Notice the `#` at the end of the filename. You can place the subsection anchor there if you want to link to a subsection:
113113

@@ -170,5 +170,5 @@ End the guide with a conclusion section that summarizes what was covered.
170170
== Next steps
171171

172172
// Here you can inlude links to other pages in docs or the blog etc. where the reader should head next.
173-
* xref:guides:about-circleci:benefits-of-circleci.adoc#[Benefits of CircleCI]
174-
* xref:guides:about-circleci:concepts.adoc#[CircleCI concepts]
173+
* xref:guides:about-circleci:benefits-of-circleci.adoc[Benefits of CircleCI]
174+
* xref:guides:about-circleci:concepts.adoc[CircleCI concepts]

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Contributors from within CircleCI can also consider setting up a local developme
3030
[#introduction]
3131
== Introduction
3232

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

3535
[#prerequisites]
3636
== Prerequisites
@@ -92,7 +92,7 @@ link:https://circleci.com/[CircleCI website]
9292

9393
To link to another page within the docs use a cross reference:
9494

95-
xref:guides:about-circleci:about-circleci.adoc#[About CircleCI]
95+
xref:guides:about-circleci:about-circleci.adoc[About CircleCI]
9696

9797
Notice the `#` at the end of the filename. You can place the subsection anchor there if you want to link to a subsection:
9898

@@ -153,5 +153,5 @@ End the tutoral with a conclusion section that summarizes what was covered.
153153
== Next steps
154154

155155
// Here you can inlude links to other pages in docs or the blog etc. where the reader should head next.
156-
* xref:guides:about-circleci:benefits-of-circleci.adoc#[Benefits of CircleCI]
157-
* xref:guides:about-circleci:concepts.adoc#[CircleCI concepts]
156+
* xref:guides:about-circleci:benefits-of-circleci.adoc[Benefits of CircleCI]
157+
* xref:guides:about-circleci:concepts.adoc[CircleCI concepts]

docs/guides/.DS_Store

0 Bytes
Binary file not shown.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
version: 2.1
2+
3+
orbs:
4+
my-orb: << url-ref >>
5+
6+
jobs:
7+
build:
8+
steps:
9+
- run: task build
10+
test:
11+
steps:
12+
- run: task test
13+
deploy:
14+
steps:
15+
- run: ccc deploy
16+
17+
workflows:
18+
- build-test-deploy:
19+
jobs:
20+
- build
21+
- test:
22+
override-with: my-orb/my-test
23+
requires: build
24+
- deploy:
25+
requires: test
114 KB
Loading
158 KB
Loading

0 commit comments

Comments
 (0)