Skip to content

Commit

Permalink
Hide Web and CLI procedures in API guide
Browse files Browse the repository at this point in the history
  • Loading branch information
maximiliankolb committed Nov 8, 2024
1 parent 311c85b commit 3731bff
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 3 deletions.
2 changes: 0 additions & 2 deletions guides/common/assembly_api-requests-in-various-languages.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ include::modules/proc_listing-users.adoc[leveloffset=+3]

include::modules/proc_creating-and-modifying-resources.adoc[leveloffset=+2]

// TODO: Only include parts?
// Use tags to mitigate this?
include::modules/proc_creating-a-user.adoc[leveloffset=+2]

include::modules/proc_modifying-a-user.adoc[leveloffset=+2]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

You can use {Project} to apply errata to a host collection.

ifndef::rest-api[]
[id="cli-applying-errata-to-a-host-collection"]
.CLI procedure
[options="nowrap", subs="+quotes,verbatim,attributes"]
Expand All @@ -12,6 +13,7 @@ You can use {Project} to apply errata to a host collection.
--inputs errata=_ERRATUM_ID1_,_ERRATUM_ID2_,... \
--search-query "host_collection = _HOST_COLLECTION_NAME_"
----
endif::[]

[id="api-applying-errata-to-a-host-collection"]
.API procedure
Expand Down
2 changes: 2 additions & 0 deletions guides/common/modules/proc_applying-errata-to-hosts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
= Applying errata to hosts

You can use {Project} apply errata to hosts.
ifndef::rest-api[]
To use the API instead of the {ProjectWebUI}, see the xref:api-applying-errata-to-hosts[].

.Procedure
. In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*.
. Select a host collection.
. On the *Actions* tab, click *Errata Installation*.
. Follow the {ProjectWebUI} to install errata.
endif::[]

[id="api-applying-errata-to-hosts"]
.API procedure
Expand Down
4 changes: 3 additions & 1 deletion guides/common/modules/proc_creating-a-user.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
= Creating a user

Use this procedure to create a user.
ifndef::rest-api[]
To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-user_{context}[].

.Procedure
Expand Down Expand Up @@ -46,7 +47,8 @@ You can modify the user details later by using the `hammer user update` command.

.Additional resources
* For more information about creating user accounts by using Hammer, enter `hammer user create --help`.

endif::[]

[id="api-creating-a-user"]
.API request
[options="nowrap", subs="+quotes,attributes"]
Expand Down

0 comments on commit 3731bff

Please sign in to comment.