Skip to content

RDSC-3533 Update RDI documentation, part 1 #1538

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

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

Conversation

stoyanr
Copy link
Contributor

@stoyanr stoyanr commented May 9, 2025

@stoyanr stoyanr force-pushed the RDSC-3533-update-rdi-docs branch from 6bd69f9 to 46ab546 Compare May 9, 2025 11:31
Copy link
Contributor

@andy-stark-redis andy-stark-redis left a comment

Choose a reason for hiding this comment

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

A few minor issues, but easily fixed, so basically LGTM.

[Redis download center](https://redis.io/downloads/) (in the *Modules, Tools & Integration* category) .

```bash
export RDI_VERSION=<version>
Copy link
Contributor

Choose a reason for hiding this comment

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

Just checking - are you sure we don't want to have the latest version shown here explicitly? I was asked a little while ago to update the download links to the latest version as part of the release process.

Copy link
Contributor Author

@stoyanr stoyanr May 9, 2025

Choose a reason for hiding this comment

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

I have concernts that this is sustainable, it means we need to do a lot of updating of these links, and always on time. From my perspective this is not really needed.
But I could be wrong here. @ZdravkoDonev-redis @yaronp68 What do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

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

in the past we brought the version number from a Jekyll / Hugo variable
@andy-stark-redis do you still use these variables? If yes we can always specify the version when we add the RN

Comment on lines 156 to 159
The [`values.yaml`](https://helm.sh/docs/topics/charts/#templates-and-values) file inside the
Helm chart contains the values you can set for the RDI Helm installation.
See the comments on each value for information on which values you may need to add or change
depending on your use case.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The [`values.yaml`](https://helm.sh/docs/topics/charts/#templates-and-values) file inside the
Helm chart contains the values you can set for the RDI Helm installation.
See the comments on each value for information on which values you may need to add or change
depending on your use case.
The [`values.yaml`](https://helm.sh/docs/topics/charts/#templates-and-values) file inside the
Helm chart contains the properties you can set for the RDI Helm installation.
See the comments by each property for more information about the values you may need to add or change
depending on your use case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The term "values" has a special meaning in Helm. It should really be "values", not "properties". The rest I corrected.

Comment on lines +120 to +121
When upgrading to RDI 1.8.0 or later from an earlier version
you must adapt your `rdi-values.yaml` file to the following changes:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When upgrading to RDI 1.8.0 or later from an earlier version
you must adapt your `rdi-values.yaml` file to the following changes:
When upgrading to RDI 1.8.0 or later from an earlier version
you must edit your `rdi-values.yaml` file to make the following changes:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What I mean is, they need to adapt their rdi-values.yaml to the changes we made to the values.yaml structure. They won't necessarily need to make all these changes because likely they have not changed most (or any) of these values. Not sure how to phrase this better?

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.

3 participants