search

valkey-io / valkey-glide

An open source Valkey client library that supports Valkey and Redis open source 6.2, 7.0 and 7.2. Valkey GLIDE is designed for reliability, optimized performance, and high-availability, for Valkey and Redis OSS based applications. GLIDE is a multi language client library, written in Rust with programming language bindings, such as Java and Python
Apache License 2.0
267 stars 56 forks source link

Publish docs and examples on a website #2725

Open Yury-Fridlyand opened 5 days ago

Yury-Fridlyand commented 5 days ago

Ideally we should publish on valkey-glide website by contributing to https://github.com/valkey-io/valkey-doc. If it not possible we need to host another website with our docs. As an extra task we can publish/update docs for Elasticache and MemeDB services which use Valkey.

Please note, we have another task (#2377) to publish auto-generated client docs to GH pages. This task is about publishing everything else somewhere - examples, content of wiki pages, readmes, etc.

avifenesh commented 4 days ago

Does docs on gh pages is not a suitable solution? It can look pretty nice. @eifrah-aws can you share your project doc site you showed? Which tech you used there? It looked pretty impressive.

If not, we can also use hugo which I really liked, and use AWS resources to create a perfect SEO. Was a full stack in the first year of my career, and we care the most about reach, so I can add some value, but we need someone that can take the main work.

Yury-Fridlyand commented 4 days ago

I don't mind hosting docs on GH pages or somewhere else, but main valkey website should have a link to that place and brief desription of what GLIDE is.

avifenesh commented 4 days ago

No argue about that, it's in discussions. My direction is if they will accept it's great, but we're creating our own brand, and we shouldn't wait. With EC and Memdb it in progress, @shohamazon is working on the page. Hope GCP will give it a nice place as well. @janhavigupta007 Do you know if GCP are planning to add Glide to the general docs of memory store? I see that https://cloud.google.com/memorystore/docs/redis/connect-redis-instance-standard#node.js_1 has an example from another libraries, you think it's possible to push into publishing glide there?