Skip to content

Commit 7a855cb

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

8 files changed

+28
-24
lines changed

assemblies/assembly-configuring-techdocs.adoc

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ After you configure {odf-name} to store the files that TechDocs generates, you c
2222
//configuring storage
2323
include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]
2424

25+
//configuring storage - Amazon S3
26+
include::modules/techdocs/proc-techdocs-configure-amazon-s3-storage.adoc[leveloffset=+2]
27+
2528
//configuring storage - ODF
2629
include::modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc[leveloffset=+2]
2730

@@ -33,14 +36,6 @@ include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[
3336

3437
include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+4]
3538

36-
//configuring storage - Amazon S3
37-
include::modules/techdocs/proc-techdocs-configure-amazon-s3-storage.adoc[leveloffset=+2]
38-
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/con-techdocs-configure-storage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
[id="con-techdocs-configure-storage_{context}"]
33
= Configuring storage for TechDocs files
44

5-
The TechDocs publisher stores generated files in local storage or in cloud storage, such as {odf-name}, Google GCS, AWS S3, or Azure Blob Storage.
5+
The TechDocs publisher stores generated files in local storage or in cloud storage, such as AWS S3 or {odf-name}.

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: 9 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,15 +51,19 @@ 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]
5858
====
5959
You can use the newly created access keys to generate a TechDocs pipeline with GitHub Actions.
6060
====
61+
. From the {ocp-short} web console, click *Topology* > *Actions* > *Restart rollout* to restart the pod.
62+
+
63+
[NOTE]
64+
====
65+
You must restart the pod to apply the configuration changes.
66+
====
6167

6268
.Verification
6369
. Go to your Amazon S3 bucket to see a set of static site files in your *Objects* list.

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

Lines changed: 7 additions & 12 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:
@@ -37,7 +42,7 @@ _<frame_border>_ :: Specifies the size of the frame border in number of pixels,
3742
====
3843
TechDocs uses DOMPurify to sanitize HTML. To prevent DOMPurify from removing the `<iframe>` elements, you must list every permitted video host, such as www.youtube.com, under the `techdocs.sanitizer.allowedIframeHosts` section of your `app-config.yaml` file. You must also add the video host to the `backend.csp` section of your `app-config.yaml` file.
3944
====
40-
. In the `frame-src` and `allowedIframeHosts` fields of your `app-config.yaml` file, add any video hosts that you want to use. For example:
45+
. In the `frame-src` and `allowedIframeHosts` fields of your `app-config.yaml` file, add any video hosts that you want to use. You can add multiple. hosts. For example:
4146
+
4247
[source,yaml,subs="+quotes,+attributes"]
4348
----
@@ -50,21 +55,11 @@ techdocs:
5055
sanitizer:
5156
allowedIframeHosts:
5257
- www.youtube.com
58+
- _<additional_video_host_url>_
5359
publisher:
5460
type: awsS3
5561
awsS3:
5662
bucketName: ${AWS_S3_BUCKET_NAME}
5763
accountId: ${AWS_ACCOUNT_ID}
5864
region: ${AWS_REGION}
5965
----
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)