Skip to content

Commit 039b4e2

Browse files
Diogenesoftorontosevein
authored andcommitted
Remove checklist
1 parent b1b39b9 commit 039b4e2

File tree

3 files changed

+41
-29
lines changed

3 files changed

+41
-29
lines changed

.markdownlint.jsonc

+3
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,7 @@
77
"code_blocks": false,
88
"tables": false,
99
},
10+
"MD007": {
11+
"indent": 4
12+
},
1013
}

docs/src/dev-manual/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is the developer manual for Enduro SDPS.
55
- [Documentation](docs.md)
66
- [Dependency management](deps.md)
77
- [Environment setup](devel.md)
8-
- [Working with Archivematica](archivematica.md)
8+
- [Working with Archivematica](archivematica.md)
99
- [Logging](logging.md)
1010
- [Makefile](make.md)
1111
- [Testing](testing.md)

docs/src/dev-manual/archivematica.md

+37-28
Original file line numberDiff line numberDiff line change
@@ -18,36 +18,45 @@ inside the cluster, and they are not tracked in the repository.
1818
the Kubernetes commands for these operations. Understanding the way these
1919
files are used is NOT required to work with Archivematica.
2020

21-
### Quick Checklist for Configuration Files
21+
### Quick checklist for configuration files
2222

23-
- [ ] .am.secret File:
24-
- Location: `hack/kube/overlays/dev-am/.am.secret`
25-
- **Contents to Check:**
23+
#### `.am.secret`
24+
25+
- Location: `hack/kube/overlays/dev-am/.am.secret`
26+
- **Contents to check:**
2627
- AM API address (e.g.,`http://host.k3d.internal:62080`)
27-
- User credentials(`user=test`, `api_key=test`)
28+
- User credentials (`user=test`, `api_key=test`)
2829
- SFTP configuration
29-
details (`sftp_host=`, `sftp_port=`, `sftp_user=`,
30-
`sftp_remote_dir=`, `sftp_private_key_passphrase=`).
31-
- [ ] .id_ed25519.secret File:
32-
- Location: `hack/kube/overlays/dev-am/.id_ed25519.secret`
33-
- **Contents to Check:**
30+
details (`sftp_host=`, `sftp_port=`, `sftp_user=`, `sftp_remote_dir=`,
31+
`sftp_private_key_passphrase=`).
32+
33+
#### `.id_ed25519.secret`
34+
35+
- Location: `hack/kube/overlays/dev-am/.id_ed25519.secret`
36+
- **Contents to check:**
3437
- SSH private key (Ensure it starts with `-----BEGIN
35-
OPENSSH PRIVATE KEY-----` and ends with `-----END
36-
OPENSSH PRIVATE KEY-----`)
37-
- [ ] .known_hosts.secret File:
38-
- Location: `hack/kube/overlays/dev-am/.known_hosts.secret`
39-
- **Contents to Check:**
38+
OPENSSH PRIVATE KEY-----` and ends with `-----END
39+
OPENSSH PRIVATE KEY-----`)
40+
41+
#### `.known_hosts.secret`
42+
43+
- Location: `hack/kube/overlays/dev-am/.known_hosts.secret`
44+
- **Contents to check:**
4045
- Known hosts entries (Look for entries starting with
41-
`|1|` and containing `ssh-rsa`, `ecdsa-sha2-nistp256`,
42-
`ssh-ed25519` etc.)
43-
- [ ] .tilt.env File:
44-
- Location: `root/`
45-
- **Contents to Check:**
46-
- ENDURO_PRES_SYSTEM = "am"
47-
- [ ] enduro.toml File:
48-
- Location: `root/`
49-
- **Contents to Check:**
50-
- Preservation Taskqueue variable must be set to "am"
46+
`|1|` and containing `ssh-rsa`, `ecdsa-sha2-nistp256`,
47+
`ssh-ed25519` etc.)
48+
49+
#### `.tilt.env`
50+
51+
- Location: `root/`
52+
- **Contents to check:**
53+
- `ENDURO_PRES_SYSTEM = "am"`
54+
55+
#### `enduro.toml`
56+
57+
- Location: `root/`
58+
- **Contents to check:**
59+
- `[preservation] taskQueue` variable must be set to "am"
5160

5261
!!! note
5362

@@ -96,8 +105,8 @@ There is more information on the configuration of the [Tilt Environment].
96105

97106
Preservation system value needed for workflow to be Archvimatica specific:
98107

99-
[Preservation]
100-
taskqueue = "am"
108+
[preservation]
109+
taskqueue = "am"
101110

102111
[kustomize secret generator]: https://kubernetes.io/docs/tasks/configmap-secret/managing-secret-using-kustomize/#create-a-secret
103-
[tilt environment]: (devel.md#-tilt-enviroment-configuration)
112+
[tilt environment]: devel.md#tilt-environment-configuration

0 commit comments

Comments
 (0)