Skip to content

Updating docker docs#402

Merged
prernadh merged 24 commits into
release/v2.10.0from
prerna/update-docker-docs
Jun 30, 2025
Merged

Updating docker docs#402
prernadh merged 24 commits into
release/v2.10.0from
prerna/update-docker-docs

Conversation

@prernadh

Copy link
Copy Markdown
Member

Rationale

Current docs needed a refresh. This first PR only tackles docker docs. Will have a subsequent PR for Helm docs.

Changes

Updating the README for docker deployments

Checklist

  • [Yes] This PR maintains parity between Docker Compose and Helm

Testing

Locally previewed the md files.

@prernadh prernadh requested a review from a team as a code owner June 24, 2025 19:53
@prernadh prernadh changed the base branch from main to release/v2.10.0 June 24, 2025 21:14
@prernadh prernadh force-pushed the prerna/update-docker-docs branch from 5287ce3 to fc11850 Compare June 24, 2025 21:17
findtopher
findtopher previously approved these changes Jun 25, 2025

@findtopher findtopher left a comment

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.

Looks good to me!

@kevin-dimichel kevin-dimichel left a comment

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.

Please run and fix the pre-commit violations.

Embedding ordered list like prefixes in headings is a different convention. I'm not sure that it adds value over an ordered list. Especially when regular text includes a : that leads to the next heading.

Comment thread docker/README.md Outdated
Comment thread docker/README.md Outdated
Comment thread docker/README.md Outdated
Comment thread docker/README.md Outdated
Comment thread docker/README.md
Comment thread docker/README.md Outdated
Comment thread docker/README.md Outdated
Comment thread docker/README.md Outdated
Comment thread docker/docs/known-issues.md Outdated
Comment thread docker/docs/known-issues.md Outdated
prernadh and others added 14 commits June 26, 2025 09:01
Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
Signed-off-by: prerna <163362853+prernadh@users.noreply.github.com>
Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
Signed-off-by: prerna <163362853+prernadh@users.noreply.github.com>
Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
Signed-off-by: prerna <163362853+prernadh@users.noreply.github.com>
Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
Signed-off-by: prerna <163362853+prernadh@users.noreply.github.com>
Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
Signed-off-by: prerna <163362853+prernadh@users.noreply.github.com>
Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
Signed-off-by: prerna <163362853+prernadh@users.noreply.github.com>
Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
Signed-off-by: prerna <163362853+prernadh@users.noreply.github.com>
Signed-off-by: prerna <163362853+prernadh@users.noreply.github.com>
findtopher
findtopher previously approved these changes Jun 27, 2025

@findtopher findtopher left a comment

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.

Now with more working links!

Looks good to me!

findtopher
findtopher previously approved these changes Jun 30, 2025

@findtopher findtopher left a comment

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.

This still looks fine to me, though it doesn't include parity with the Helm documentation.

@findtopher findtopher left a comment

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.

:shipit:

@prernadh

Copy link
Copy Markdown
Member Author

This still looks fine to me, though it doesn't include parity with the Helm documentation.

@findtopher I haven't included anything new, just rewritten it and I will do that for Helm too. Just in a separate PR

@prernadh prernadh merged commit dbc9042 into release/v2.10.0 Jun 30, 2025
10 checks passed
@prernadh prernadh deleted the prerna/update-docker-docs branch June 30, 2025 22:04
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.

4 participants