Skip to content

Commit 532d689

Browse files
committed
Improve how content specific to ota members is handled
1 parent 3312601 commit 532d689

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

content/deployment/how-to/deploy.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ Before starting, ensure you have:
2727
- A GitHub user account to automate actions such as committing entries in versions and snapshots repositories, reporting issues when tracking fails, publishing releases…
2828
- [Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) installed on your local machine
2929

30-
> **Note**: This guide is intended for both Open Terms Archive organization members and external contributors. Some steps marked with "_Specific to Open Terms Archive organization members_" are only relevant for organization members as they involve access to the organization's shared password database. External contributors should adapt these steps to their own security practices while following the same deployment principles.
31-
3230
## 1. Configure the server
3331

3432
First, ensure your server provides unsupervised access:
@@ -100,9 +98,9 @@ First, ensure your server provides unsupervised access:
10098
- Go to `https://github.com/<organization>/<collection_id>-declarations/settings/secrets/actions`
10199
- Create a new secret named `SERVER_SSH_KEY` with the private key content
102100

103-
3. > _Specific to Open Terms Archive organization members_
104-
>
105-
> Back up the keys in the shared password database by creating an entry titled "Deployment SSH Key" in the collection folder and storing both public and private keys in this entry
101+
{{< showIfParam "ota" >}}
102+
3. Back up the keys in the shared password database by creating an entry titled "Deployment SSH Key" in the collection folder and storing both public and private keys in this entry
103+
{{< /showIfParam >}}
106104

107105
## 4. Set up GitHub permissions
108106

@@ -117,9 +115,9 @@ First, ensure your server provides unsupervised access:
117115

118116
4. Keep this token for the next steps
119117

120-
5. > _Specific to Open Terms Archive organization members_
121-
>
122-
> Back up the token in the shared password database by creating an entry titled "GitHub Token" in the collection folder and storing the token in this entry
118+
{{< showIfParam "ota" >}}
119+
5. Back up the token in the shared password database by creating an entry titled "GitHub Token" in the collection folder and storing the token in this entry
120+
{{< /showIfParam >}}
123121

124122
## 5. Configure and encrypt secrets
125123

@@ -163,9 +161,9 @@ This section uses [Ansible Vault](https://docs.ansible.com/ansible/latest/vault_
163161

164162
4. Commit the changes to the repository
165163

166-
5. > _Specific to Open Terms Archive organization members_
167-
>
168-
> Back up the vault key in the shared password database by creating an entry titled "Vault Key" in the collection folder and storing the vault key in this entry
164+
{{< showIfParam "ota" >}}
165+
5. Back up the vault key in the shared password database by creating an entry titled "Vault Key" in the collection folder and storing the vault key in this entry
166+
{{< /showIfParam >}}
169167

170168
## 6. Set up collection-specific SSH key
171169

@@ -189,9 +187,9 @@ This section uses [Ansible Vault](https://docs.ansible.com/ansible/latest/vault_
189187
- Go to github.com/settings/ssh/new
190188
- Add the public key with title "<collection_name> collection"
191189

192-
6. > _Specific to Open Terms Archive organization members_
193-
>
194-
> Back up the key in the shared password database by creating an entry titled "OTA-Bot GitHub SSH key" in the collection folder and storing both public and private keys in this entry
190+
{{< showIfParam "ota" >}}
191+
6. Back up the key in the shared password database by creating an entry titled "OTA-Bot GitHub SSH key" in the collection folder and storing both public and private keys in this entry
192+
{{< /showIfParam >}}
195193

196194
## 7. Configure email notifications
197195

@@ -224,9 +222,10 @@ This section describes how to configure the engine to use a specific SMTP server
224222
ansible-vault encrypt .env
225223
```
226224

227-
5. > _Specific to Open Terms Archive organization members_
228-
> Create a new SMTP key in Brevo and name it "<collection_name> collection"
229-
> Back up the key in the shared password database by creating an entry titled "SMTP Key" in the collection folder and storing the credentials in this entry
225+
{{< showIfParam "ota" >}}
226+
5. Create a new SMTP key in Brevo and name it "<collection_name> collection"
227+
6. Back up the key in the shared password database by creating an entry titled "SMTP Key" in the collection folder and storing the credentials in this entry
228+
{{< /showIfParam >}}
230229

231230
## 8. Test the deployment
232231

0 commit comments

Comments
 (0)