Data access api README/Docs update

[anamanica]

Change Summary

Overview

This PR combines the information in the README for the data access api into the docs.

(I will have to cut down the README in a PR on the imap-data-access repo.)

New Dependencies

None

New Files

None

Deleted Files

None

Updated Files

• index.rst
  • adding in README information

Testing

None

[bourque]

Adding @greglucas as a reviewer here since he wrote most of this documentation and may have opinions about this!

[bourque]

Pertains to IMAP-Science-Operations-Center/imap-data-access#75

[greglucas]

@greglucas Totally agree, and I think the end goal is to have all of the documentation pertaining to the Data Access API in this RtD page, and then basically have the imap-data-access repo README just say something like "For documentation how to use this, go to the official docs here". Does that sound good to you?

I would personally prefer the opposite direction 🤷 I think a package should be standalone if possible and the README should describe whats going on within that package without needing to click somewhere else. I just don't know how feasible any of it is to go either direction.

[bourque]

Suggested change

	Command Line Utility
	====================
	To Install
	----------
	Command Line Utility
	--------------------
	To Install
	^^^^^^^^^^

It looks like these headings (and throughout this document) are still messing up the main RtD page layout. I think these need to be changed to another level 'down' in markdown.

[anamanica]

Oh! Sorry, Okay. I think I understand what you are saying now! Should I do this with every heading?

[bourque]

Yes, except for the very first one (line 4), which is fine as is.

[bourque]

This part is describing the REST API specification, so it should be moved to under that section.

[bourque]

Similar to the last comment, this is describing the REST API so should also be moved (same with the /upload section.

[bourque]

Thanks for these updates, this is looking really good! As Greg suggested, I think it is worth exploring if we can automatically include the contents of the imap-data-access README file in here, but that can be explored in a separate PR if you'd like.

I just have a few suggestions to help clarify some areas or make them a bit more readable.

[bourque]

Since this document is quite lengthy now and have several sections and subsections, I suggest to add a table of contents somewhere towards the top. (Could be done in a future PR if desired)

[bourque]

Nevermind, Ana pointed out to me that there is a built-in table of contents on ReadTheDocs, which I totally missed!

[bourque]

Thanks for making those updates, this looks good to go!

[bourque]

@anamanica Just a heads up that you will likely run into merge conflicts once #844 is merged, since that PR is changing the directory names a bit.

[maxinelasp]

@anamanica are you planning on merging this soon?