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
Copy file name to clipboardExpand all lines: docs/orbs/modules/author/pages/orbs-best-practices.adoc
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,10 @@
6
6
7
7
[#general]
8
8
== General
9
+
This guide covers best practices for creating orbs.
9
10
10
-
[discrete#give-your-orb-a-descriptive-name]
11
-
====Give your orb a descriptive name
11
+
[#give-your-orb-a-descriptive-name]
12
+
=== Give your orb a descriptive name
12
13
13
14
An orb "slug" is made up of a _namespace_ and _orb_ name separated by a forward slash. The namespace represents, the individual, company, or organization that owns and maintains the orb, while the orb name itself should describe the product, service, or action provided by the individual orb.
14
15
@@ -24,13 +25,13 @@ An orb "slug" is made up of a _namespace_ and _orb_ name separated by a forward
24
25
| `company/cci-plugin`
25
26
|===
26
27
27
-
[discrete#categorize-your-orb]
28
-
==== Categorize your orb
28
+
[#categorize-your-orb]
29
+
=== Categorize your orb
29
30
30
31
Categorizing your orb allows it to be searchable on the link:https://circleci.com/developer/orbs[Orb Registry] by category. To see how you can categorize your orb using the CircleCI CLI, refer to the relevant section in the xref:orb-author.adoc#categorizing-your-orb[Orb Authoring Process] guide.
==== Ensure all orb components include descriptions
33
+
[#ensure-all-orb-components-include-descriptions]
34
+
=== Ensure all orb components include descriptions
34
35
35
36
Commands, Jobs, Executors, Examples, and Parameters can all accepts descriptions. Ensure each and every component of your orb has a helpful description and provides any additional documentation that may be needed.
36
37
@@ -45,8 +46,8 @@ steps:
45
46
46
47
Create detailed descriptions that fully explain the benefit and usage of the orb element. Descriptions are an excellent place for more specific documentation related to each component.
=== Ensure your orb-publishing context is restricted
50
51
51
52
If using the Orb Developer Kit, your CircleCI Personal Access Token is saved to a context in your Organization. Ensure you restrict this context so that jobs accessing it will only run when triggered or approved by you or other approved users. For more information, see the xref:guides:security:contexts.adoc#restrict-a-context[Using Contexts] guide.
0 commit comments