refactor: documentation structure.

[pantierra]

This refactor will allow us to deploy the k8s doc on eoapi.dev

[j08lue]

Oooh, nice! How can I best review this?

[pantierra]

Added a make serve-docs for you and all.

[j08lue]

I reviewed the structure via the rendered version (pip install mkdocs-material && make serve-docs) but consider it to become an addition to our general eoAPI docs at https://eoapi.dev/intro/.

Suggestions

1. I think the Overview may not be needed. The TOC is in the page menu and some of the more general information on eoAPI (e.g. about the services) is available from eoapi.dev/intro.
2. Instead of a catch-all "Advanced" section, perhaps make a dedicated one for "Auth" and include the contributing / CI/CD information in a "Contributing" section somewhere, similar to https://eoapi.dev/contributing/ - could be a top-level nav item

Just my 2ct - if you think differently, pls let me know, then I'll approve nonetheless

[ciaransweet]

I know this content is pre this PR - But would it be useful to link to the actual components githubs/relevant docs pages here?

[pantierra]

Indeed, thanks! I added the github repo here. For the relevant docs i adjusted the main README.md to point to eoapi.dev/deployment/kubernetes with the goal to declare this for the one single place for docs, the eoapi.dev.

[pantierra]

Thanks for your reviews! I tried to incorporate your feedback.

@j08lue, I simplified the "overview" page, to avoid duplication. Made the advanced page the one about authentication. And added the repo where people find on the README.md the contribution info. In case we want to add such a section for whole eoapi.dev, we can do this in a next step on the other repo.

What do you think now?

[pantierra]

I merged for now. Happy to do any adjustments in follow-ups, @j08lue. I can imagine once we deploy it together on eoapi.dev we will have a slightly changing perspective and improvements will be necessary anyway.