Documentation: more friendly docs for beginners

v6d-io / v6d

vineyard (v6d): an in-memory immutable data manager. (Project under CNCF, TAG-Storage)

https://v6d.io

Apache License 2.0

828 stars 122 forks source link

Documentation: more friendly docs for beginners #296

Open sighingnow opened 3 years ago

sighingnow commented 3 years ago

Describe your problem

[x] What is vineyard/Why vineyard matters/Why bother
[ ] Objects in vineyard
- [x] Concepts? Remote/Local objects? How distributed objects are served?
- [ ] How the objects/builders are designed?
- [ ] How the code generation works to reduce boilerplate code?
- [x] Streams in VIneyard
- [ ] How multi-lang SDK works
- [x] Access objects in vineyard from IPC/RPC clients
[ ] Drivers
- [ ] IO
- [ ] Serialization/Deserialization
[ ] Kubernetes Integration
- [x] Deployment on Kubernetes: helm or Python API
- [ ] Custom scheduler on Kubernetes

Additional context

Add any other context about the problem here.

chaitravi-ce commented 3 years ago

I am interested to solve this issue. Can you please give me a more detailed insight? Thanks in advance

sighingnow commented 3 years ago

Hi @chaitravi-ce , thanks for your attention on this task. This issue is to improve the content of our "get started" and "dive into" section in our documentation.

You may need to be familiar with the vineyard's design space and API first. As a fresh mind to vineyard, we also very willing to listen from you about where we should make improvement!

chaitravi-ce commented 3 years ago

I think we should include the process of installing libgrape-lite along with vineyard according to the requirement of vineyard in the documentation. This would eliminate the error.

sakkshm26 commented 2 years ago

Can I also work on this issue?

sighingnow commented 2 years ago

Hi @sakkshm26,

Yes, we still need help to polish our documentaion.

However to be honest, we currently have no clear plan (I mean a new content in our mind) to improve/reconstruct the docs. As a fresh mind to project vineyard, you may need to be familiar with the vineyard's design space and API first. After that we can discuss further about the doable items.

We are willing to listen to newcomers to the project!

sighingnow commented 2 years ago

However to be honest, we currently have no clear plan (I mean a new content in our mind) to improve/reconstruct the docs. As a fresh mind to project vineyard, you may need to be familiar with the vineyard's design space and API first. After that we can discuss further about the doable items.

TODO items added.

sighingnow commented 2 years ago

Can I also work on this issue?

Hi @sakkshm26 do you still have interest to collaborate on the documentation work?

Thanks!