gravitino icon indicating copy to clipboard operation
gravitino copied to clipboard

[Docs] Rework docs

Open tengqm opened this issue 8 months ago • 10 comments

tengqm avatar Apr 07 '25 02:04 tengqm

Thanks @tengqm . This really is a big PR, seems like everything is refactored. I will spend time on it. Greatly appreciated.

jerryshao avatar Apr 07 '25 22:04 jerryshao

So I took a look at the first file and there are multiple grammatical issues. Compared with the original the sentences have been broken over lines, and as previously discussed this can introduce errors. Some problems mentioned above were in the original file, but more have been introduced.

justinmclean avatar Apr 09 '25 03:04 justinmclean

Some problems mentioned above were in the original file, but more have been introduced.

This is a ridiculous accusation. You are saying this as if you read the original docs carefully, you are saying this without appreciating the huge effort on restructuring the docs layout.

Go back home and enjoy your little pity grammar/syntax checker, or read the sembr.org for some good things to learn.

This huge pile of docs still need a lot of improvements, including accuracy and clarity. I was not pretending that I'm delivering a collection of perfect docs. There are many defects in the docs.

tengqm avatar Apr 09 '25 07:04 tengqm

Is GVFS suitable to put in the client module? cc @diqiu50 Maybe we should have the document about fuse, too.

jerqi avatar Apr 14 '25 07:04 jerqi

Do we need a document java-client.md in the module client?

jerqi avatar Apr 14 '25 07:04 jerqi

Do we need a document java-client.md in the module client?

That would be a good idea. I'd suggest we add an overview of the Java client, with references to the generated Java docs.

tengqm avatar Apr 14 '25 12:04 tengqm

Is GVFS suitable to put in the client module? cc @diqiu50 Maybe we should have the document about fuse, too.

Currently, 'GVFS' is relocated to catalogs/fileset/gvfs, next to catalogs/fileset/hadoop. If we have client side module(s), we may want to put it under client/. As always, all kinds of suggestions/ideas are welcomed. For example, maybe treating gvfs as a fileset variant is not good, there is a better home for it?

tengqm avatar Apr 14 '25 12:04 tengqm

Is GVFS suitable to put in the client module? cc @diqiu50 Maybe we should have the document about fuse, too.

Currently, 'GVFS' is relocated to catalogs/fileset/gvfs, next to catalogs/fileset/hadoop. If we have client side module(s), we may want to put it under client/. As always, all kinds of suggestions/ideas are welcomed. For example, maybe treating gvfs as a fileset variant is not good, there is a better home for it?

image

This is GVFS client code. For me GVFS is a implementation of the client instead of server side. It wrapped the Gravitino client and hide the communication with Gravitino server. And then it implemented the Hadoop Filesystem interface. Maybe others can give another suggestion.

jerqi avatar Apr 14 '25 12:04 jerqi

Is GVFS suitable to put in the client module? cc @diqiu50 Maybe we should have the document about fuse, too.

Currently, 'GVFS' is relocated to catalogs/fileset/gvfs, next to catalogs/fileset/hadoop. If we have client side module(s), we may want to put it under client/. As always, all kinds of suggestions/ideas are welcomed. For example, maybe treating gvfs as a fileset variant is not good, there is a better home for it?

image

This is GVFS client code. For me GVFS is a implementation of the client instead of server side. It wrapped the Gravitino client and hide the communication with Gravitino server. And then it implemented the Hadoop Filesystem interface. Maybe others can give another suggestion.

Thanks for the clarification. My previous understanding could be wrong. If GVFS is only about client side emulation/simulation, I'm happy to find a new home for it (maybe client/gvfs?). All ears to other suggestions.

tengqm avatar Apr 14 '25 13:04 tengqm

superseded by #7111

tengqm avatar Apr 30 '25 13:04 tengqm