port wiki documentation to readthedocs

[ivotron]

• [ ] create outline on readthedocs (revise the github wiki one)
• [ ] look at the github wiki documentation and decide what to change/add/remove
• [ ] bring the wiki documentation to readthedocs

[manishprivet]

Hi @ivotron, I wanted to work on the issue. I was wondering if I can use the existing boilerplate in the repo, or do I have to create one?

Or can we use something entirely different, like docusaurus?

[jlefevre]

Hi @manishprivet,  - this is a bit out of date but you can please take a look at this issue in the newer repo here: https://github.com/uccross/arrow/issues/98, and we can update that issue with more information as well.  Since we want to upstream our documentation, we should follow the Arrow Dataset documentation style, for example the existing Arrow Dataset Parquet fragment, for our new Arrow Dataset Parquet Rados fragment.  Here is our newer README

We will also want to add more documentation of design and architecture, and we have some figures for that, we are developing now with various alternative designs. Thanks for your interest!

[rajpratyush]

@jlefevre I would like to contribute to this issue can you tell me how to get started?

[jlefevre]

Hi @rajpratyush, a way to get started would first be to review the Apache Arrow documentation and build the existing docs [here](. https://github.com/apache/arrow/blob/master/docs/source/developers/documentation.rst). Then check out how the docs are put together here, as we will need to add docs for our extensions noted above toward creating our PR for Arrow. Please see this issue in our Arrow repo uccross/arrow#98

[Rishav0809]

Hey @jlefevre, I wanted to work on this issue, hence I went through the roadmap you suggested above, but was unable to get a clear picture of what I need to do.

Can you help me in better understanding the issue, and the way in which I should proceed?

[jlefevre]

Hi Rishav, probably the best way to review the other general documentation and more specifically for dataset Parquet file format (see fragment methods), and then also the other connectors as an example then we can proceed from there. Thank you, Jeff

On Mon, Mar 22, 2021 at 11:53 AM Rishav Mishra @.***> wrote:

Hey @jlefevre https://github.com/jlefevre, I wanted to work on this issue, hence I went through the roadmap you suggested above, but was unable to get a clear picture of what I need to do.

Can you help me in better understanding the issue, and the way in which I should proceed?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/uccross/skyhookdm-ceph-cls/issues/42#issuecomment-804310945, or unsubscribe https://github.com/notifications/unsubscribe-auth/AADT6DJFPP4UHGTOZ4XEPETTE6G2JANCNFSM4NZUEFEQ .

[rajpratyush]

@jlefevre I have one small doubt

If you are building the documentation on Windows, not all sections may build properly.

Why this will occur ? and to avoid this do I need to have ubuntu (in virtual machine or physically )

[JayjeetAtGithub]

@rajpratyush Can you try building with docker to be platform independent ? Here is the instructions. https://arrow.apache.org/docs/developers/documentation.html#building-with-docker