I think that it would be great to produce this kind of content. I'm giving a presentation on Arrow to my local Rust meetup (virtually) next week and these are similar to the topics I will be covering there.
We should be careful with the balance of content between the Restructured Text Format documentation and the documentation in the crate that gets published to docs.rs though. The rustdoc documentation is unit-tested to ensure that it is always up to date and we will have to manually update the RTF documentation for each release, and the project is still evolving rather quickly. If the sample code included in RTF also exists as examples in the repo that get tested then we can just copy and paste the contents over each time we release perhaps. Andy. On Fri, Oct 16, 2020 at 3:59 PM Micah Kornfield <emkornfi...@gmail.com> wrote: > Java and C++ have tutorials in Restructured Text Format in the docs folder > [1]. I think creating something similar for Rust might be the best place > to start. These are rendered on the website. For example Java is located > at [2]. > > > [1] https://github.com/apache/arrow/tree/master/docs/source > [2] https://arrow.apache.org/docs/java/index.html > > On Fri, Oct 16, 2020 at 2:48 PM Fernando Herrera < > fernando.j.herr...@gmail.com> wrote: > > > I was working on the blog post I mentioned before regarding Arrow usage > > (rust) and how to use the different elements available in the create. > After > > some thought, these were the topics I want to include: > > > > 1. Arrays examples and how they look like > > Basic arrays and nested arrays > > The buffer structure and how data is stored > > Builders usage > > Examples of complex arrays and how to construct them (using builders > and > > from) > > 2. What is a record batch? > > How to construct a record batch > > How a RecordBatch is used with IPC > > 3. How to read files? > > CSV files and Parquet files > > 4. How to share information > > What is Arrow flight? > > How to set up a server with Rust > > Examples > > 5. How to query information from arrays? > > Datafusion examples > > > > However, as I was working on the examples > > <https://github.com/elferherrera/test_example/blob/master/src/main.rs> > > that > > I was planning to use (most of them came from the Arrow repository) I > > thought that the best format would be a book, something similar to the > Rust > > book. I think this format will help us to fully explain how each > > constructor can be used in detail and how each of the data arrays can be > > used and manipulated. > > > > What do you think about it? > > > > I could start the book using the examples in the repository and the tests > > done as a base. However, I cannot find a quick tutorial on setting up a > > book like that, let alone how to host it. I know it has to be made using > > .md files, but that's as far as I have got. Can somebody give me a > pointer > > on setting up something like that? > > > > Regards > > > > On Thu, Oct 15, 2020 at 3:18 PM Mark Farnan <m...@markfarnan.com> wrote: > > > > > I would agree with this. > > > > > > I’ve been working with the GO Arrow library last few weeks, and took a > > > while to get head around it all / how to use etc. > > > Even then not sure i’ve got it right. > > > > > > Usage examples would be great. > > > > > > Regards > > > > > > Mark > > > > > > > On Oct 14, 2020, at 4:08 PM, Fernando Herrera < > > > fernando.j.herr...@gmail.com> wrote: > > > > > > > > I was wondering if besides this blog post there should be another on > > with > > > > an example of usage. I think that is one of the key things missing > for > > > > Arrow in general. This example should show the problems that Arrow is > > > > solving and how to implement the solution in real life. > > > > > > > > On Tue, Oct 13, 2020 at 10:12 AM Andy Grove <andygrov...@gmail.com> > > > wrote: > > > > > > > >> There has been a huge amount of activity in the Rust subproject for > > the > > > >> 2.0.0 release and I think that we should write a Rust-specific blog > > > post to > > > >> go on the Arrow blog. > > > >> > > > >> I made a brief start at a Google doc, which is mostly just bullet > > points > > > >> listing some things we could talk about. I'm sure I've missed some > > > things, > > > >> and maybe we have too many things to talk about so we might want to > > try > > > and > > > >> summarize some of this. > > > >> > > > >> Here is the doc ... I would appreciate any help anyone can provide > > with > > > >> this. Perhaps if each contributor could flesh out the content around > > > things > > > >> they directly worked on or are knowledgeable about, that would be > > great. > > > >> > > > >> > > > >> > > > > > > https://docs.google.com/document/d/1RY7oa7ldi4RnyFzk3_5NHiiQl7IcvZgXFq3FYr5iwFc/edit?usp=sharing > > > >> > > > >> Thanks, > > > >> > > > >> Andy. > > > >> > > > > > > > > >
