Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation for Nessie on Kubernetes #7997

Merged
merged 2 commits into from Jan 29, 2024
Merged

Improve documentation for Nessie on Kubernetes #7997

merged 2 commits into from Jan 29, 2024

Conversation

adutra
Copy link
Contributor

@adutra adutra commented Jan 27, 2024 •
edited

This commit introduces the following changes:

  • The Helm charts page has been repurposed as "Nessie on Kubernetes" guide and improved with examples for different databases.
  • Portions of the in-tree README for the Helm chart were repurposed (because they had little to do with Helm charts):
    • Text related to secrets was moved to the "Nessie on Kubernetes" guide.
    • Text related to minikube was moved to a new "Nessie on Minikube" guide.
  • The Docker guide has been slightly augmented, notably to mention the different Nessie image repositories and how to pass environment variables.

snazy
snazy reviewed Jan 27, 2024
View reviewed changes
Copy link
Member

@snazy snazy left a comment

Choose a reason for hiding this comment

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

Haven't looked at the contents yet, so more a question: is it worth to add/change stuff in the root-README as well?

@adutra
Improve documentation for Nessie on Kubernetes
3736e67 
This commit introduces the following changes:

- The Helm charts page has been repurposed as "Nessie on Kubernetes" guide
  and improved with examples for different databases.
- Portions of the in-tree README for the Helm chart were repurposed (because
  they had little to do with Helm charts):
  - Text related to secrets was moved to the "Nessie on Kubernetes" guide.
  - Text related to minikube was moved to a new "Nessie on Minikube" guide.
- The Docker guide has been slightly augmented, notable to mention the
  different Nessie image repositories and how to pass environment variables.
@adutra
Copy link
Contributor Author

adutra commented Jan 28, 2024

Haven't looked at the contents yet, so more a question: is it worth to add/change stuff in the root-README as well?

Good idea, I added a (very minor) change to the root README.

dimas-b
dimas-b reviewed Jan 29, 2024
View reviewed changes
site/docs/try/docker.md Outdated Show resolved Hide resolved
site/docs/try/docker.md Outdated Show resolved Hide resolved
site/docs/try/docker.md Outdated Show resolved Hide resolved
@adutra adutra merged commit bec6ee0 into projectnessie:main Jan 29, 2024
17 checks passed
@adutra adutra deleted the nessie-deployment-docs branch January 29, 2024 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@snazy snazy snazy left review comments

@dimas-b dimas-b dimas-b approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@adutra @snazy @dimas-b