Skip to content

Commit 5bcecb8

Browse files
Update icons to use inline images (#112)
* replace icons with our own icon images and remove icon font integration * remove references to font icons * add icons to the style guide
1 parent cb80c57 commit 5bcecb8

File tree

299 files changed

+363
-607
lines changed

Some content is hidden

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

299 files changed

+363
-607
lines changed

docs/contributors/modules/ROOT/pages/index.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
= Contributing to CircleCI Docs
22
:page-description: An overview of contributing to CircleCI docs including page templates and our style guide.
3-
:icons: font
43
:experimental:
54

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

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Formatting
2-
:icons: font
32
:experimental:
43

54
[#styling-text]

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Headings
2-
:icons: font
32

43
* Write headings in a logical sequence. If you read section titles in order, the flow should present a good storyline for the doc.
54

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Cross references and links
2-
:icons: font
32

43
[#cross-references]
54
== Cross references

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Style and voice
2-
:icons: font
32
:experimental:
43

54
== Talk confidently and directly

docs/contributors/modules/docs-style/pages/style-guide-overview.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Style guide overview
2-
:icons: font
32

43
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.
54

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Using code samples
2-
:icons: font
32

43

54
* Provide code examples to help with clarity, and to help the reader reproduce the subject matter.

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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Using images
2-
:icons: font
32
:experimental:
43

54
== Guidelines for all images
@@ -36,6 +35,8 @@ image::guides:ROOT:style-guide_screenshot-sample.png[Change user icon, main]
3635

3736
== Mark up screenshots
3837

38+
NOTE: This section is outdated and will be updated soon.
39+
3940
Sometimes a screenshot will need to be marked up to provide more context for a user. Below is an example of a screenshot that has been marked up with an approved color.
4041

4142
.Example of marked up screenshot
@@ -55,3 +56,16 @@ Any text added to a screenshot should be no less than 18px, and can be larger if
5556
* If taking a screenshot of the CircleCI app include the sidebar menu so the reader can see what page you are on.
5657

5758
* Think about how clear the location of your screenshot is for unfamiliar users. It is best to include the full width of the screen, if possible, so the location of what you are drawing attention to is clear. An image of a button with no wider reference can be confusing.
59+
60+
== Icons
61+
62+
To add an icon to the flow of text we use the image macro as follows:
63+
64+
[source,adoc]
65+
----
66+
Some text with the edit icon image:guides:ROOT:icons/edit-solid.svg[edit icon] in it.
67+
----
68+
69+
Looks like this:
70+
71+
Some text with the edit icon image:guides:ROOT:icons/edit-solid.svg[edit icon] in it.

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Using lists
2-
:icons: font
32

43
* To generate numbered steps (an ordered list) use the following syntax:
54
+

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Using tables
2-
:icons: font
32

43
* For markdown content use the following format for tables:
54
+

0 commit comments

Comments
 (0)