Skip to content

Commit a5ef88c

Browse files
committed
RHIDP-7202: Apply SME comments
1 parent fe45e00 commit a5ef88c

7 files changed

+16
-19
lines changed

assemblies/assembly-configuring-techdocs.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,3 @@ include::modules/techdocs/proc-techdocs-configure-amazon-s3-storage.adoc[levelof
3939
//configuring CI/CD
4040
include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1]
4141

42-
include::modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2]
43-
44-
include::modules/customizing-techdocs/proc-techdocs-generate-site.adoc[leveloffset=+2]
45-
46-
include::modules/customizing-techdocs/proc-techdocs-publish-site.adoc[leveloffset=+2]

modules/customizing-techdocs/con-techdocs-config-cicd.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// ARCHIVED
2+
13
:_mod-docs-content-type: CONCEPT
24
[id="con-techdocs-config-cicd_{context}"]
35
= Configuring CI/CD to generate and publish TechDocs sites

modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// ARCHIVED
2+
13
:_mod-docs-content-type: PROCEDURE
24
[id="proc-techdocs-config-cicd-prep-repo_{context}"]
35
= Preparing your repository for CI

modules/customizing-techdocs/proc-techdocs-generate-site.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// ARCHIVED
2+
13
:_mod-docs-content-type: PROCEDURE
24
[id="proc-techdocs-generate-site_{context}"]
35
= Generating the TechDocs site

modules/customizing-techdocs/proc-techdocs-publish-site.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// ARCHIVED
2+
13
:_mod-docs-content-type: PROCEDURE
24
[id="proc-techdocs-publish-site_{context}"]
35
= Publishing the TechDocs site

modules/techdocs/proc-techdocs-configure-amazon-s3-storage.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
.Prerequisites
1212

1313
* You are logged in to your AWS account.
14+
* You have sufficient permissions to create and configure the AWS S3 bucket
15+
and the IAM policy in the AWS console
1416

1517
.Procedure
1618
. On the AWS console, create an AWS S3 bucket.
@@ -49,9 +51,7 @@ where
4951
_<bucket_name>_ :: Specifies the name of your Amazon S3 bucket.
5052
+
5153
.. On the *Create policy > Specify permissions* page, enter a *Policy name*.
52-
. Create a user and assign the IAM policy.
53-
.. On the *Create user > Specify user details* page, enter a *User name*.
54-
.. On the *Create user > Set permissions* page, select *Attach policies directly* and select the permissions policy that you created.
54+
. Assign the IAM policy to a new or existing user.
5555
. Generate a new access key and a new secret access key.
5656
+
5757
[NOTE]

modules/techdocs/proc-techdocs-embed-videos.adoc

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@
88

99
You can use `<iframe>` elements to embed videos into your TechDocs.
1010

11+
.Prerequisites
12+
13+
* An administrator has configured your AWS S3 bucket to store TechDocs sites.
14+
* An administrator has configured the appropriate `techdocs.sanitizer.allowedIframeHosts` and `backend.csp` settings in your `app-config.yaml` file.
15+
1116
.Procedure
1217

1318
. In the section of the TechDocs file that you want to embed a video into, add the following configuration:
@@ -57,14 +62,3 @@ techdocs:
5762
accountId: ${AWS_ACCOUNT_ID}
5863
region: ${AWS_REGION}
5964
----
60-
+
61-
. To authenticate with AWS, add the following configuration to your `app-config.yaml` file. For example:
62-
+
63-
[source,yaml]
64-
----
65-
aws:
66-
accounts:
67-
- accountId: ${AWS_ACCOUNT_ID}
68-
accessKeyId: ${AWS_ACCESS_KEY_ID}
69-
secretAccessKey: ${AWS_SECRET_ACCESS_KEY}
70-
----

0 commit comments

Comments
 (0)