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

Update docs. #2299

Closed
wants to merge 7 commits into from
Closed

Update docs. #2299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d4c0c70
Update docs.
Yury-Fridlyand Sep 16, 2024
0f2ff6d
Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
Yury-Fridlyand Sep 16, 2024
a1a0c4f
Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
Yury-Fridlyand Sep 16, 2024
5f7905b
Apply suggestions from code review
Yury-Fridlyand Sep 16, 2024
9b0d534
Apply suggestions from code review
Yury-Fridlyand Sep 16, 2024
98a9c21
Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
Yury-Fridlyand Sep 18, 2024
65017d6
Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
Yury-Fridlyand Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,7 @@ Looking at the existing issues is a great way to find something to contribute on
- [Python](./python/DEVELOPER.md)

## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.
This project has adopted the [Valkey Code of Conduct](https://github.com/valkey-io/valkey/blob/unstable/CODE_OF_CONDUCT.md).
ikolomi marked this conversation as resolved.
Show resolved Hide resolved


## Security issue notifications
Expand Down
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@ Valkey General Language Independent Driver for the Enterprise (GLIDE), is an ope
## Supported Engine Versions
Valkey GLIDE is API-compatible with the following engine versions:

| Engine Type | 6.2 | 7.0 | 7.2 |
|-----------------------|-------|-------|-------|
| Valkey | - | - | V |
| Redis | V | V | V |
| Engine Type | 6.2 | 7.0 | 7.2 | 8.0 |
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGMT

|-----------------------|-------|-------|-------|-------|
| Valkey | - | - | V | V |
| Redis | V | V | V | - |

## 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).
Copy link
Collaborator

Choose a reason for hiding this comment

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

remove ,


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

Choose a reason for hiding this comment

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

LGTM

- [Documentation](https://github.com/valkey-io/valkey-glide/wiki)

## Getting Help
Expand Down
2 changes: 1 addition & 1 deletion csharp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

remove csharp readme


# Getting Started - C# Wrapper
Expand Down
2 changes: 1 addition & 1 deletion java/client/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ publishing {
}
developers {
developer {
name = 'valkey-glide'
name = 'Valkey GLIDE Maintainers'
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGMT

url = 'https://github.com/valkey-io/valkey-glide.git'
}
}
Expand Down
7 changes: 3 additions & 4 deletions node/README.md
View file
Open in desktop
Copy link
Collaborator

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

Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

remove Current Status


# 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).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe replacing what was node to Go?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

and c#?

Copy link
Collaborator

Choose a reason for hiding this comment

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

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


## NodeJS supported version

Node.js 16.20 or higher.
Node.js 16.20+, 18.x and 20.x.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator

Choose a reason for hiding this comment

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

#2233 (comment)


## Documentation

Expand Down
4 changes: 2 additions & 2 deletions node/npm/glide/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM

"main": "build-ts/index.js",
"module": "build-ts/index.js",
"type": "commonjs",
Expand All @@ -26,7 +26,7 @@
"client",
"valkey-glide"
],
"author": "Amazon Web Services",
"author": "Valkey GLIDE Maintainers",
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM

"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/valkey-io/valkey-glide/issues"
Expand Down
2 changes: 1 addition & 1 deletion node/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"typescript": "^5.5.4",
"uuid": "^10.0.0"
},
"author": "Valkey contributors",
"author": "Valkey GLIDE Maintainers",
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM

"license": "Apache-2.0",
"publishConfig": {
"${registry_scope}registry": "https://registry.npmjs.org/",
Expand Down
Loading