Update docs. #2299

Yury-Fridlyand · 2024-09-16T20:59:02Z

Signed-off-by: Yury-Fridlyand <[email protected]>

README.md

Yury-Fridlyand · 2024-09-16T21:00:33Z

node/README.md


 ## NodeJS supported version

-Node.js 16.20 or higher.
+Node.js 16.20+, 18.* and 20.*.


Node 22 is not supported (#2233)

@jamesx-improving — still waiting for your response on that, I would really like us to support latest version of a language.

This one needs more validatioin. I'll update the original issue shortly.

Preliminary result is that both 22.8 and 22.0 have no issue, so chances are my 22.7 env is contaminated.

acarbonetto

Please confirm language with Glide team

README.md

node/README.md

Co-authored-by: Andrew Carbonetto <[email protected]> Signed-off-by: Yury-Fridlyand <[email protected]>

README.md

Signed-off-by: Yury-Fridlyand <[email protected]>

avifenesh · 2024-09-16T22:01:35Z

node/README.md


 # Getting Started - Node Wrapper

 ## System Requirements

-In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/aws/projects/187/).
+In this release, Valkey GLIDE is available for Python, Java, and Node, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/valkey-io/projects/11).


Maybe replacing what was node to Go?

Is it?
Not really actively, we can add it when it will.

node/npm/glide/package.json

avifenesh · 2024-09-16T22:08:23Z

node/README.md


 ## NodeJS supported version

-Node.js 16.20 or higher.
+Node.js 16.20+, 18.x and 20.x.


I think it's better to test once with 17 and 19 and just write 16 and above. This is very specific and look suspicious.

#2233 (comment)

CONTRIBUTING.md

ikolomi · 2024-09-23T12:18:53Z

README.md

-|-----------------------|-------|-------|-------|
-| Valkey                |   -   |   -   |   V   |
-| Redis                 |   V   |   V   |   V   |
+| Engine Type           |  6.2  |  7.0  |  7.2  |  8.0  |


ikolomi · 2024-09-23T12:19:09Z

README.md


 ## Current Status
-In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/valkey-io/projects/11).
+In this release, Valkey GLIDE is available for Python, Java, and Node, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/valkey-io/projects/11).


ikolomi · 2024-09-23T12:19:26Z

README.md


 ## Getting Started
 -   [Java](./java/README.md)
 -   [Python](./python/README.md)
+-   [Node](./node/README.md)


ikolomi · 2024-09-23T12:21:23Z

csharp/README.md

@@ -12,7 +12,7 @@ Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valk

 ## Current Status

-We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Redis stakeholders.
+We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project [roadmap](https://github.com/orgs/valkey-io/projects/11). We welcome questions and contributions from all Valkey stakeholders.
 This preview release is recommended for testing purposes only.


remove csharp readme

ikolomi · 2024-09-23T12:21:54Z

java/client/build.gradle

@@ -209,7 +209,7 @@ publishing {
                }
                developers {
                    developer {
-                        name = 'valkey-glide'
+                        name = 'Valkey GLIDE Maintainers'


ikolomi · 2024-09-23T12:23:45Z

node/README.md

@@ -8,18 +8,17 @@ Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valk

 ## Current Status

-We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Redis stakeholders.
-This preview release is recommended for testing purposes only.
+We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project [roadmap](https://github.com/orgs/valkey-io/projects/11). We welcome questions and contributions from all Valkey stakeholders.


remove Current Status

ikolomi · 2024-09-23T12:29:28Z

node/README.md

need to update the README.md

ikolomi · 2024-09-23T12:30:41Z

node/npm/glide/package.json

@@ -2,7 +2,7 @@
    "name": "${scope}${pkg_name}",
    "types": "build-ts/index.d.ts",
    "version": "${package_version}",
-    "description": "An AWS-sponsored, open-source Redis client.",
+    "description": "General Language Independent Driver for the Enterprise (GLIDE) for Valkey",


ikolomi · 2024-09-23T12:30:52Z

node/npm/glide/package.json

@@ -26,7 +26,7 @@
        "client",
        "valkey-glide"
    ],
-    "author": "Amazon Web Services",
+    "author": "Valkey GLIDE Maintainers",


ikolomi · 2024-09-23T12:31:05Z

node/package.json

@@ -58,7 +58,7 @@
        "typescript": "^5.5.4",
        "uuid": "^10.0.0"
    },
-    "author": "Valkey contributors",
+    "author": "Valkey GLIDE Maintainers",


ikolomi · 2024-09-23T14:47:00Z

superseded by #2346

Update docs.

d4c0c70

Signed-off-by: Yury-Fridlyand <[email protected]>

Yury-Fridlyand added the docs Documentation label Sep 16, 2024

Yury-Fridlyand requested a review from a team as a code owner September 16, 2024 20:59

Yury-Fridlyand commented Sep 16, 2024

View reviewed changes

Yury-Fridlyand added 2 commits September 16, 2024 14:02

Signed-off-by: Yury-Fridlyand <[email protected]>

0f2ff6d

Signed-off-by: Yury-Fridlyand <[email protected]>

a1a0c4f

acarbonetto reviewed Sep 16, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

node/README.md Outdated Show resolved Hide resolved

Apply suggestions from code review

5f7905b

Co-authored-by: Andrew Carbonetto <[email protected]> Signed-off-by: Yury-Fridlyand <[email protected]>

Yury-Fridlyand commented Sep 16, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Apply suggestions from code review

9b0d534

Signed-off-by: Yury-Fridlyand <[email protected]>

avifenesh reviewed Sep 16, 2024

View reviewed changes

node/npm/glide/package.json Outdated Show resolved Hide resolved

avifenesh reviewed Sep 16, 2024

View reviewed changes

Yury-Fridlyand added the Release blocker Can't release without. label Sep 17, 2024

Yury-Fridlyand linked an issue Sep 18, 2024 that may be closed by this pull request

Doc files are outdated #2315

Closed

Signed-off-by: Yury-Fridlyand <[email protected]>

98a9c21

avifenesh reviewed Sep 18, 2024

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

acarbonetto approved these changes Sep 19, 2024

View reviewed changes

Signed-off-by: Yury-Fridlyand <[email protected]>

65017d6

yipin-chen approved these changes Sep 20, 2024

View reviewed changes

ikolomi reviewed Sep 23, 2024

View reviewed changes

README.md

## Getting Started

- [Java](./java/README.md)

- [Python](./python/README.md)

- [Node](./node/README.md)

Copy link

Collaborator

ikolomi Sep 23, 2024

Choose a reason for hiding this comment

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

LGTM

ikolomi reviewed Sep 23, 2024

View reviewed changes

node/README.md

Copy link

Collaborator

ikolomi Sep 23, 2024

Choose a reason for hiding this comment

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

need to update the README.md

ikolomi reviewed Sep 23, 2024

View reviewed changes

ikolomi closed this Sep 23, 2024

Yury-Fridlyand deleted the node/yuryf-update-readme branch September 23, 2024 14:53

Yury-Fridlyand mentioned this pull request Oct 1, 2024

Doc files are outdated #2315

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs. #2299

Update docs. #2299

Yury-Fridlyand commented Sep 16, 2024 •

edited

Loading

Yury-Fridlyand Sep 16, 2024

avifenesh Sep 16, 2024

jamesx-improving Sep 16, 2024

acarbonetto left a comment

avifenesh Sep 16, 2024

Yury-Fridlyand Sep 16, 2024

avifenesh Sep 16, 2024

avifenesh Sep 16, 2024

avifenesh Sep 16, 2024

ikolomi Sep 23, 2024

ikolomi Sep 23, 2024

ikolomi Sep 23, 2024

ikolomi Sep 23, 2024

ikolomi Sep 23, 2024

ikolomi Sep 23, 2024

ikolomi Sep 23, 2024

ikolomi Sep 23, 2024

ikolomi Sep 23, 2024

ikolomi Sep 23, 2024

ikolomi commented Sep 23, 2024

Update docs. #2299

Update docs. #2299

Conversation

Yury-Fridlyand commented Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

acarbonetto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ikolomi commented Sep 23, 2024

Yury-Fridlyand commented Sep 16, 2024 •

edited

Loading