New documentation site for Seldon Core v2

[ramonpzg]

The main purpose of this PR is to migrate our docs from readthedocs to GitBook.

Here are the changes I have made to transition the docs from one place to another.

Edits ✍️

• Moved all documents out of source
• Captions inside of mermaid diagrams have been moved to underneath the diagram as markdown.

Add Ons 🚀

• SUMMARY.md file at the root of the docs directory to organize the docs.
• I added a new directory called images to the docs directory and most images reside there now. I have added the correct path where necessary.
• Referenced code via tags such as {literalinclude} have been replaced by the actual code these were referencing.
• Mermaid diagram sections now start with mermaid as opposed to {mermaid}.
• Block quotes such as {note} or {warning} you now need to surround block quotes with {% hint style="warning" %} and {% endhint %} (for more information see here).
• Examples inside the docs directory now contain full documents rather than a reference. This includes:
  • Huggingface speech to sentiment pipeline

Removed 🧹

Removed all files related to Sphinx and readthedocs.

• Makefile
• make.bat
• requirements-docs.txt
• index.md
• conf.py
• .gitignore - the files in it are now in the main .gitignore in the root directory of the repo
• {toctree} at the end of most markdown files as gitbook provides this functionality
• {literalinclude} and other references to different code files.
• Full tutorials available in different directories should be edited from the docs as opposed to being references from the samples directory. This will help create a single place for tutorials and examples and minimize references to different files.

Admin 💼

• All code references to full files now use GitHub Gist to stay up to date with master. Any suggestions on how to keep this in sync with branches for different versions of the docs, would be much appreciated.

Follow-Up Work (Different PR) 🤝

• references to source of truth files

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ ramonpzg
❌ gitbook-bot
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[lc525]

@ramonpzg I would like to form a view on the upgrade path to GitBook & timelines. At the moment, if I want to write some more Core 2 docs, would you recommend waiting for this PR to be merged first?

[ramonpzg]

@ramonpzg I would like to form a view on the upgrade path to GitBook & timelines. At the moment, if I want to write some more Core 2 docs, would you recommend waiting for this PR to be merged first?

@lc525 -- I will have the PR ready for review by sometime this week and would recommend waiting until the new docs have been merged. The reason is that since the docs directory structure has changed completely, rebasing with v2 to get the new changes might complicate things a bit. If these need to go out asap then no worries and move ahead with the changes. I can always look up the files that changed and update them manually on my branch.

[lc525]

I will have the PR ready for review by sometime this week and would recommend waiting

@ramonpzg It's not that urgent, I can wait for this to be merged. Thank you for your work on this!

[lc525]

Reviewed with requested changes. Most I believe are minor, but I see the ability to include file contents (that was previously discussed) as very important.

[ramonpzg]

I have created a new branch called v2-docs-master and pointed this PR towards it. Because this new branch was made with the V2 branch as a base, it is possible that there might be a few inconsistencies if the docs have changed in the last 2 weeks.

[lc525]

lgtm as a base, further changes to be built on top of this PR

To summarise our discussion, as next tasks:

• @ramonpzg to investigate ways in which file references can point to the file corresponding to the exact release branch/tag rather than to v2
• core 2 team to define changes required to the release process and test those