replace "e.g." with "for example" under pki/docs/installation [skip ci] #4966
Conversation
| @@ -30,7 +30,7 @@ require to modify the authorization script | |||
|
|
|||
|
|
|||
| If you have chosen to use *PostgreSQL* for user management, you first | |||
| need to prepare a database (e.g. est) to access the | |||
| need to prepare a database, for example est, to access the | |||
There was a problem hiding this comment.
Since we're not using parentheses anymore, we probably should enclose est in backticks (i.e. est) to clarify that it's an identifier, not an English word, to avoid confusions.
|
@edewata I also noticed that I shouldn't replace the "e.g." in acme/Installing-ACME-Responder-using-PKI-Server-ACME-CLI.adoc because they are command outputs inside code block. I'll adjust the script to look and ignore code blocks. |
- if ')' is not followed by a punctuation, replace it with ',' - if ')' is followed by a punctuation, remove the ')' - ignore "e.g." inside asciidoc code blocks, e.g. acme/Installing-ACME-Responder-using-PKI-Server-ACME-CLI.adoc - adding a pair of backticks to surround the example [skip ci]
| @@ -6,7 +6,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq | |||
|
|
|||
| == CA Subsystem Installation | |||
|
|
|||
| Prepare a deployment configuration (e.g. `ca.cfg`) to deploy CA subsystem. | |||
| Prepare a deployment configuration, for example `ca.cfg`, to deploy CA subsystem. | |||
| By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`. | |||
There was a problem hiding this comment.
Another style we follow is not to use future tense. So we would say:
By default, the subsystem is deployed into a Tomcat instance called ...
| @@ -75,7 +75,7 @@ $ chown pkiuser:pkiuser ca-certs.p12 | |||
|
|
|||
| == CA Subsystem Installation | |||
|
|
|||
| Prepare a deployment configuration (e.g. `ca-clone.cfg`) to deploy CA subsystem clone. | |||
| Prepare a deployment configuration, for example `ca-clone.cfg`, to deploy CA subsystem clone. | |||
| By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`. | |||
There was a problem hiding this comment.
again change to
By default, the subsystem is deployed into a Tomcat instance called pki-tomcat.
| @@ -33,7 +33,7 @@ $ pki-server cert-export subsystem \ | |||
|
|
|||
| Note: It is assumed that the CA signing certificate has been exported into `ca_signing.crt` | |||
|
|
|||
| Prepare a file (e.g. ca.cfg) that contains the deployment configuration, for example: | |||
| Prepare a file, for example `ca.cfg`, that contains the deployment configuration, for example: | |||
There was a problem hiding this comment.
delete the , for example at the end:
Prepare a file, for example ca.cfg, that contains the deployment configuration:
| @@ -59,7 +59,7 @@ The command will export the following certificates (including the certificate ch | |||
|
|
|||
| Note that the existing SSL server certificate will not be exported. | |||
There was a problem hiding this comment.
Note that the existing SSL server certificate is not exported.
| @@ -5,7 +5,7 @@ Follow this process to install a CA subsystem with a custom CA signing key, CSR, | |||
| Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured. | |||
|
|
|||
| == Starting CA Subsystem Installation | |||
| Prepare a file (e.g. ca-step1.cfg) that contains the deployment configuration step 1, for example: | |||
| Prepare a file, for example `ca-step1.cfg`, that contains the deployment configuration step 1, for example: | |||
There was a problem hiding this comment.
Delete ", for example" at the end:
Prepare a file, for example ca-step1.cfg, that contains the deployment configuration step 1:
| @@ -19,7 +19,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq | |||
|
|
|||
| == TKS Subsystem Installation | |||
|
|
|||
| Prepare a file (e.g. tks.cfg) that contains the deployment configuration, for example: | |||
| Prepare a file, for example `tks.cfg`, that contains the deployment configuration, for example: | |||
There was a problem hiding this comment.
delete ", for example" at the end of the sentence
| @@ -8,7 +8,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq | |||
|
|
|||
| == TKS Subsystem Installation | |||
|
|
|||
| Prepare a file (e.g. tks.cfg) that contains the deployment configuration, for example: | |||
| Prepare a file, for example `tks.cfg`, that contains the deployment configuration, for example: | |||
There was a problem hiding this comment.
delete ", for example" at the end of the sentence
| @@ -9,7 +9,7 @@ This step is described link:https://www.dogtagpki.org/wiki/DS_SSL[here]. | |||
|
|
|||
| == TKS Subsystem Installation | |||
|
|
|||
| Prepare a file (e.g. tks.cfg) that contains the deployment configuration, for example: | |||
| Prepare a file, for example `tks.cfg`, that contains the deployment configuration, for example: | |||
There was a problem hiding this comment.
delete ", for example" at the end of the sentence
| @@ -8,7 +8,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq | |||
|
|
|||
| == TPS Subsystem Installation | |||
|
|
|||
| Prepare a file (e.g. tps.cfg) that contains the deployment configuration, for example: | |||
| Prepare a file, for example `tps.cfg`, that contains the deployment configuration, for example: | |||
There was a problem hiding this comment.
delete ", for example" at the end of the sentence
| @@ -9,7 +9,7 @@ This step is described link:https://www.dogtagpki.org/wiki/DS_SSL[here]. | |||
|
|
|||
| == TPS Subsystem Installation | |||
|
|
|||
| Prepare a file (e.g. tps.cfg) that contains the deployment configuration, for example: | |||
| Prepare a file, for example `tps.cfg`, that contains the deployment configuration, for example: | |||
There was a problem hiding this comment.
delete ", for example" at the end of the sentence
result of my new script, replace_eg3.py, which replaces "e.g." with "for example". It also handles punctuation so that if any occurs after ')' the ')' is simply removed.