Skip to content

Commit

Permalink
doc update (vmware-tanzu#1138)
Browse files Browse the repository at this point in the history
Signed-off-by: Volkan Özçelik <[email protected]>
  • Loading branch information
v0lkan authored Sep 18, 2024
1 parent 8d9a56e commit 4ac23af
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/content/documentation/architecture/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ Here is a different look at how **VSecM** and **SPIRE** components are deployed
in a Kubernetes cluster, focusing on the Services exposed by the components and
volumes mounted to the Pods.

Click on the image to see it in full size:
Open the image in a new tab to see it in full size:

![VSecM and SPIRE Deployment](/assets/vsecm-infra.png "VSecM and SPIRE Deployment Diagram")

Expand Down
2 changes: 1 addition & 1 deletion docs/content/documentation/use-cases/init-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ variables or file mounts similar to how it did before.

Here is a screencast that demonstrates this use case:

```text
```txt
WORK IN PROGRESS
```

Expand Down
2 changes: 1 addition & 1 deletion docs/content/documentation/use-cases/mounting-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ other feasible way to pass secrets to the app.

Here is a screencast that demonstrates this use case:

```text
```txt
WORK IN PROGRESS
```

Expand Down
2 changes: 1 addition & 1 deletion docs/content/documentation/use-cases/randomized-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ randomized secrets.

Here is a screencast that demonstrates this use case:

```text
```txt
WORK IN PROGRESS
```

Expand Down
2 changes: 1 addition & 1 deletion docs/content/documentation/use-cases/root-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ by providing the root cryptographic material.

Here is a screencast that demonstrates this use case:

```text
```txt
WORK IN PROGRESS
```

Expand Down
2 changes: 1 addition & 1 deletion docs/content/documentation/use-cases/template-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ these scripts in source control is a security incident waiting to happen.

Here is a screencast that demonstrates this use case:

```text
```txt
WORK IN PROGRESS
```

Expand Down
2 changes: 1 addition & 1 deletion docs/content/documentation/use-cases/vsecm-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Fetching secrets using VSecM SDK will also enable you to…

Here is a screencast that demonstrates this use case:

```text
```txt
WORK IN PROGRESS
```

Expand Down
Binary file modified docs/static/assets/vsecm-infra.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/templates/shortcodes/adrs.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@
* [ADR-0019: Use RESTful APIs for Communication Between Components](@/documentation/architecture/adrs/20240714-adr-0019-use-restful-apis.md)
* [ADR-0020: VSecM will not enforce expiration and invalid before time for secrets](@/documentation/architecture/adrs/20240714-adr-0020-vsecm-does-not-control-expiration-of-secrets.md)
* [ADR-0021: VSecM Shall Use Environment Variables for Configuration](@/documentation/architecture/adrs/20240715-adr-0021-use-environment-variables-for-configuration.md)
* [ADR-0022: VSecM Shall Use the Latest Stable Dependencies](@/documentation/architecture/adrs/20240715-adr-0022-use-latest-stable-dependencies.md)
* [ADR-0022: VSecM Shall Use the Latest Stable Dependencies](@/documentation/architecture/adrs/20240715-adr-0022-use-the-latest-stable-dependencies.md)
26 changes: 26 additions & 0 deletions hack/publish-docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#!/usr/bin/env bash

# /*
# | Protect your secrets, protect your sensitive data.
# : Explore VMware Secrets Manager docs at https://vsecm.com/
# </
# <>/ keep your secrets... secret
# >/
# <>/' Copyright 2023-present VMware Secrets Manager contributors.
# >/' SPDX-License-Identifier: BSD-2-Clause
# */

cd docs || exit 1
zola build
cd ..
rm -rf public
mv docs/public public

if [[ -z "$VSECM_S3_BUCKET" || -z "$VSECM_DISTRIBUTION_ID" ]]; then
echo "Error: VSECM_S3_BUCKET and VSECM_DISTRIBUTION_ID must be set."
exit 1
fi

aws s3 sync public/ "$VSECM_S3_BUCKET"

aws cloudfront create-invalidation --distribution-id "$VSECM_DISTRIBUTION_ID" --paths "/*"

0 comments on commit 4ac23af

Please sign in to comment.