Skip to content

Commit 3801be1

Browse files
Table updates (#9743)
* Tried testing for broken tables, reverted that attempt * Instead just allowed all tables horizontal scroll if needed with wrapper
1 parent 0a766cb commit 3801be1

File tree

162 files changed

+1432
-528
lines changed

Some content is hidden

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

162 files changed

+1432
-528
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
:page-noindex: true
33
:experimental:
44

5+
pass:[<!-- vale off -->]
6+
57
[#styling-text]
68
== Styling text
79

@@ -94,3 +96,5 @@ This is a longer admonition with an ordered list:
9496
. Step 2
9597
. Step 3
9698
****
99+
100+
pass:[<!-- vale on -->]

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Headings
22

3+
pass:[<!-- vale off -->]
34
* Write headings in a logical sequence. If you read section titles in order, the flow should present a good storyline for the doc.
45

56
* Do not skip heading levels. For example, try not to jump from `h2` to `h4`, missing out `h3`.
@@ -21,3 +22,4 @@
2122
** **Bad:** For more information, see the xref:guides:getting-started:hello-world.adoc["Hello world"] guide.
2223
2324
* Do not use inline literal text in headings.
25+
pass:[<!-- vale on -->]

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
:experimental:
44
:page-layout: subsection
55

6+
pass:[<!-- vale off -->]
67
This guide is a reference for contributors to CircleCI docs. Our style guide evolves so you will probably find older documentation does not meet the requirements set out here. Use this guide to help you write new docs, and when working on existing documentation it would be great if you can make edits to help keep everything consistent.
78

89
For further information on markdown and AsciiDoc syntax refer to the https://github.github.com/gfm/[markdown documentation] and https://asciidoctor.org/docs/user-manual/[Asciidoctor User Guide].
10+
pass:[<!-- vale on -->]

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Cross references and links
22

3+
pass:[<!-- vale off -->]
34
This page covers how to create links and cross references in CircleCI docs.
45

56
[#cross-references]
@@ -26,3 +27,4 @@ See the link:https://docs.antora.org/antora/latest/page/resource-id-coordinates/
2627
----
2728
link:https://circleci.com[CircleCI]
2829
----
30+
pass:[<!-- vale on -->]

docs/contributors/modules/docs-style/pages/style-and-voice.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= Style and voice
22
:experimental:
33

4+
pass:[<!-- vale off -->]
45
== Talk confidently and directly
56
Use an active voice, talk directly to the reader using simple, direct, clear and confident language. Using active voice helps us to keep instructions as short as possible, and is, in most cases, the quickest way to convey meaning to the reader
67

@@ -18,6 +19,8 @@ Assume technical competence but explain concepts clearly and simply. Some concep
1819
* Avoid contractions, for example "don't", "you're". They make the content harder for non-native english speakers to read.
1920
* Do not use time-sentitive language like, "new" or "soon" or "in preview" in main prose. These can get missed when changes are needed. If this language is needed it should be in a banner (admonition) that is clearly there to indicate the time-sensitive nature of the content.
2021

22+
[.table-scroll]
23+
--
2124
[cols=2*, options="header"]
2225
|===
2326
| Avoid
@@ -38,6 +41,7 @@ Assume technical competence but explain concepts clearly and simply. Some concep
3841
| Guys
3942
| Folks, y’all, people, humans, teammates
4043
|===
44+
--
4145

4246
== Talking about CircleCI
4347
* The CircleCI is referred to as the "web app".
@@ -70,3 +74,4 @@ Assume technical competence but explain concepts clearly and simply. Some concep
7074
** Read the setup guide …
7175
** Set up your account …
7276
* **Do use** open source, **not** opensource, or open-source
77+
pass:[<!-- vale on -->]

docs/contributors/modules/docs-style/pages/using-code-samples.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Using code samples
22

3+
pass:[<!-- vale off -->]
34
* Provide code examples to help with clarity, and to help the reader reproduce the subject matter.
45

56
* CircleCI config should always be tested as valid before adding it to docs.
@@ -52,4 +53,5 @@ workflows:
5253
my-workflow:
5354
jobs:
5455
- hello-job
55-
----
56+
----
57+
pass:[<!-- vale on -->]

docs/contributors/modules/docs-style/pages/using-images.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
:page-description: Guidelines for using images in CircleCI documentation.
33
:experimental:
44

5+
pass:[<!-- vale off -->]
56
This page provides guidelines for using images in CircleCI documentation.
67

78
== Guidelines for all images
@@ -109,4 +110,5 @@ sequenceDiagram
109110
participant Bob
110111
Alice->>Bob: Hello Bob, how are you?
111112
Bob-->>Alice: Great!
112-
....
113+
....
114+
pass:[<!-- vale on -->]

docs/contributors/modules/docs-style/pages/using-lists.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Using lists
22

3+
pass:[<!-- vale off -->]
34
* To generate numbered steps (an ordered list) use the following syntax:
45
+
56
[source,adoc]
@@ -28,3 +29,4 @@
2829
* Capitalize the first word of each item in a list.
2930
3031
* If the text in the bullet is a full sentence or completes the intro stem use a period at the end.
32+
pass:[<!-- vale on -->]

docs/contributors/modules/docs-style/pages/using-tables.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
= Using tables
22

3+
pass:[<!-- vale off -->]
34
== Basic table syntax
45
Use the following format for tables:
56

67
[source,adoc]
78
----
9+
10+
[.table-scroll]
11+
--
812
[cols=4*, options="header"]
913
|===
1014
| Key
@@ -17,10 +21,13 @@ Use the following format for tables:
1721
| String
1822
| Should currently be `2`
1923
|===
24+
--
2025
----
2126

2227
Looks like:
2328

29+
[.table-scroll]
30+
--
2431
[cols=4*, options="header"]
2532
|===
2633
| Key
@@ -33,6 +40,7 @@ Looks like:
3340
| String
3441
| Should currently be `2`
3542
|===
43+
--
3644

3745
== Extra wide tables
3846

@@ -77,4 +85,5 @@ Looks like:
7785

7886
== Advanced table options
7987

80-
There are a lot of options for formatting tables, cell, rows, columns. For more information, see the link:https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/[Asciidoctor docs]
88+
There are a lot of options for formatting tables, cell, rows, columns. For more information, see the link:https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/[Asciidoctor docs]
89+
pass:[<!-- vale on -->]

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
:page-description: A short page description goes here max 155 characters.
44
:experimental:
55

6+
pass:[<!-- vale off -->]
67
////
78
:page-platform: drives the platform badges that you see in the info bar under the page title.
89
:page-description: is used for SEO and meta description. This should be a short description of the page content. Between 70 and 155 characters.
@@ -69,6 +70,8 @@ Break up large blocks of text where possible to help make it easier to consume.
6970

7071
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.
7172

73+
[.table-scroll]
74+
--
7275
.This is a table
7376
[cols="1,1,2"]
7477
|===
@@ -78,6 +81,7 @@ This section shows how to create a table. This example has one heading row and o
7881
|Text for row 1 column 2
7982
|Text for row 1 column 3
8083
|===
84+
--
8185

8286
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].
8387

@@ -193,3 +197,4 @@ Place the answer here after the question.
193197
* xref:template-tutorial.adoc[Tutorial template]
194198
* xref:guides:about-circleci:benefits-of-circleci.adoc[Benefits of CircleCI]
195199
* xref:guides:about-circleci:concepts.adoc[CircleCI concepts]
200+
pass:[<!-- vale on -->]

0 commit comments

Comments
 (0)