Discussion to possibly restructure MAAP Docs

[smk0033]

Creating more of a long-term ticket for discussion here. As we've been creating R Docs, organization of our docs have come up. Our docs are written in Python, but we are working through writing R-equivalents. For the time being, we are adding a separate R section under "Technical Tutorials" as this will probably be easier for the user to find what they're looking for.

As more R docs come out, we've thought about adding cells with the R equivalent in the existing Python notebooks. (For @smk0033 to do: test magic %%R in Python notebooks within the R workspace).

Opening this ticket to further discussion on the organization of our Docs.

cc: @grallewellyn @wildintellect @rtapella @zacdezgeo

[rtapella]

• how do you expect someone to use the docs? e.g.
  • use the doc as a tutorial and walk thru cell-by-cell
  • use the doc as a template to copy and edit
  • ?
• do you expect that you'll need to update the Python and R versions at the same time?
• Is there a lot of overlapping content (e.g. paragraph descriptions) that are identical for both versions?

[grallewellyn]

It might make the docs convoluted to have the R version next to the Python version

Is R that popular amongst our users that it is worth doing this? Or is it better to keep R in a separate section?

[rtapella]

@smk0033 any updated thoughts on this? I think that having separated docs probably makes sense as any given scientist will be using either Python or R. We could cross-reference the same doc in each language at the top for ease of navigation.

I know that the separate docs is probably more maintenance because you need to sync things up in two places. How's it been so far?