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

Publish docs and examples on a website #2725

Open
Yury-Fridlyand opened this issue Nov 20, 2024 · 3 comments
Open

Publish docs and examples on a website #2725

Yury-Fridlyand opened this issue Nov 20, 2024 · 3 comments
Labels
docs Documentation

Comments

@Yury-Fridlyand
Copy link
Collaborator

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.

@Yury-Fridlyand Yury-Fridlyand added the docs Documentation label Nov 20, 2024
@avifenesh
Copy link
Collaborator

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
Copy link
Collaborator Author

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
Copy link
Collaborator

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

No branches or pull requests

2 participants