Skip to content

Commit c988164

Browse files
authored
Adding navigation items (#99)
* Adding navigation items * Adding more navigation items * Adding navigation elements and landing pages description * Implementing review suggestions * Removing subsection landing pages from navigation * Deleting obsolete files
1 parent b50d84e commit c988164

File tree

4 files changed

+24
-12
lines changed

4 files changed

+24
-12
lines changed

docs/orbs/modules/ROOT/nav.adoc

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
* xref:index.adoc[Orbs]
2-
** xref:use:index.adoc[Use Orbs]
2+
** Use Orbs
33
*** xref:use:orb-intro.adoc[Introduction to using orbs]
4+
*** xref:use:managing-url-orbs-allow-lists.adoc[Managing URL orbs allow lists]
5+
** Author Orbs
6+
*** xref:author:orb-author.adoc[Introduction to authoring orbs]
7+
*** xref:author:orb-development-kit.adoc[Orb development kit]
8+
*** xref:author:create-an-orb.adoc[Create an orb with the development kit]
9+
*** xref:author:testing-orbs.adoc[Testing orbs]
10+
*** xref:author:creating-orbs.adoc[Publishing orbs]
11+
*** xref:author:orb-author-validate-publish.adoc[Manually create an orb]
12+
*** xref:author:orbs-best-practices.adoc[Orb authoring best practices]
13+
** Reference
14+
*** xref:author:orb-concepts.adoc[Orb concepts]
15+
*** xref:author:orb-author-faq.adoc[Orb authoring FAQ]
416
*** xref:use:orbs-faq.adoc[Orbs FAQ]
5-
** xref:author:index.adoc[Author Orbs]
17+
*** xref:reference:ROOT:reusing-config.adoc[Reusing configuration]
18+

docs/orbs/modules/author/pages/index.adoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/orbs/modules/author/pages/orbs-best-practices.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66

77
[#general]
88
== General
9+
This guide covers best practices for creating orbs.
910

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
1213

1314
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.
1415

@@ -24,13 +25,13 @@ An orb "slug" is made up of a _namespace_ and _orb_ name separated by a forward
2425
| `company/cci-plugin`
2526
|===
2627

27-
[discrete#categorize-your-orb]
28-
==== Categorize your orb
28+
[#categorize-your-orb]
29+
=== Categorize your orb
2930

3031
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.
3132

32-
[discrete#ensure-all-orb-components-include-descriptions]
33-
==== Ensure all orb components include descriptions
33+
[#ensure-all-orb-components-include-descriptions]
34+
=== Ensure all orb components include descriptions
3435

3536
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.
3637

@@ -45,8 +46,8 @@ steps:
4546

4647
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.
4748

48-
[discrete#ensure-your-orb-publishing-context-is-restricted]
49-
==== Ensure your orb-publishing context is restricted
49+
[#ensure-your-orb-publishing-context-is-restricted]
50+
=== Ensure your orb-publishing context is restricted
5051

5152
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.
5253

docs/orbs/modules/use/pages/index.adoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)