Skip to content

Docs: Add link to request x86_64 Docker image#215

Merged
kateandrews merged 4 commits into
mainfrom
request-x86_64-docker-image
May 1, 2025
Merged

Docs: Add link to request x86_64 Docker image#215
kateandrews merged 4 commits into
mainfrom
request-x86_64-docker-image

Conversation

@kateandrews
Copy link
Copy Markdown
Contributor

Acknowledgment

By submitting this pull request, I confirm that CipherStash can use, modify, copy, and redistribute this contribution, under the terms of CipherStash's choice.

Signed-off-by: Kate Andrews <keandrews@gmail.com>
Copy link
Copy Markdown
Contributor

@auxesis auxesis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good start, and we should move it to a reference doc.

Comment thread README.md Outdated
> **Prerequisites:** Before you start you need to have this software installed:
> - [Docker](https://www.docker.com/) — see Docker's [documentation for installing](https://docs.docker.com/get-started/get-docker/)
>
> **Supported architectures:** We currently support `arm64v8` architectures. If you're interested in a `x86_64` Docker image, upvote [this idea](https://github.com/cipherstash/proxy/discussions/214).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> **Supported architectures:** We currently support `arm64v8` architectures. If you're interested in a `x86_64` Docker image, upvote [this idea](https://github.com/cipherstash/proxy/discussions/214).
> **Supported architectures:** CipherStash Proxy provides Docker images for these architectures: `linux/arm64`
> If you're interested in a Docker image for other architectures (like `linux/amd64`), upvote [this idea](https://github.com/cipherstash/proxy/discussions/214).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I think this might be better in a reference doc, rather than in the main README.

It's too low a level of detail for a getting started guide, but it's the sort of thing that makes sense in a reference doc.

Signed-off-by: Kate Andrews <keandrews@gmail.com>
Signed-off-by: Kate Andrews <keandrews@gmail.com>
@kateandrews kateandrews requested a review from auxesis May 1, 2025 00:52
Copy link
Copy Markdown
Contributor

@auxesis auxesis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @kateandrews!

I have added one small suggested copy change.

Comment thread docs/reference.md Outdated
Co-authored-by: Lindsay Holmwood <lindsay@cipherstash.com>
Signed-off-by: Kate Andrews <keandrews@gmail.com>
@kateandrews kateandrews merged commit 0e2aa2b into main May 1, 2025
2 checks passed
@kateandrews kateandrews deleted the request-x86_64-docker-image branch May 1, 2025 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants