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.

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

Docs: Update couchdb/README.md - change cookeAuthSecret to erlangCookie and make code blocks easier to copy via copy button on github #132

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jessebot
Copy link

What this PR does / why we need it:

This updates cookeAuthSecret to erlangCookie in the README for the helm chart directory, as that is what couchdb looks for in the secret can pre-generate.

I've also updated the code blocks to not have $ in front of each command, so that users can more easily copy and paste the commands to test them. This is particularly helpful for users with disabilities as they don't need to mind the space and dollar sign when trying out the commands in the docs.

Which issue this PR fixes

Special notes for your reviewer:

Thanks for maintaining this helm chart!

Checklist

[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.

  • Variables are documented in the README.md

…de blocks easier to copy via copy button on github
couchdb/README.md Outdated Show resolved Hide resolved
Copy link
Member

@willholley willholley left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! As per my review comment, I think the change to the secrets documentation is an "and" rather than an "or", since both secret values are required.

couchdb/README.md Outdated Show resolved Hide resolved
couchdb/README.md Outdated Show resolved Hide resolved
couchdb/README.md Outdated Show resolved Hide resolved
couchdb/README.md Outdated Show resolved Hide resolved
couchdb/README.md Outdated Show resolved Hide resolved
@jessebot jessebot requested a review from willholley May 29, 2024 11:14
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.

None yet

2 participants