Flyte docs overhaul (phase 1)

[neverett]

Tracking issue

This is phase 1 in a multi-phase project to overhaul the Flyte docs to make them easier to maintain and contribute to, and more useful and usable for readers.

To test these changes locally, you will need to do the following:

• Update your monodocs conda environment with the new monodocs-environment.lock.yaml file: conda env update --file monodocs-environment.lock.yaml
• Clone flytesnacks and check out the nikki/docs/refresh branch
• Set the FLYTESNACKS_LOCAL_PATH environment variable to the location of your local copy of flytesnacks

Note: The monodocs build will fail for this PR until the linked flytesnacks PR is merged.

Why are the changes needed?

These changes make the Flyte docs easier to maintain and contribute to and lay the groundwork for phase 2 of the Flyte docs overhaul project, in which we'll significantly update the content itself to be more useful, usable, and accurate for readers. They also bring the Flyte docs into closer alignment with Union docs by switching the theme from furo to pydata.

What changes were proposed in this pull request?

• Switch to pydata theme. This meant reorganizing docs subdirectories and updating templates, among other changes.
• Use the Algolia Docsearch extension and environment variables instead of putting the Algolia API key in a JS file and requiring custom HTML and CSS to render the search box.
• Update the flytesnacks and flyte docs contribution guides.

Note: There are two issues left from phase 1 that I am moving to phase 2 in order to not block the rest of phase 1 work from being completed and merged:

• For now, flyteidl docs are in their own section instead of in the API section because moving them to the API section causes build errors.
• I removed the old version switcher, since it was part of the old theme. I will add the pydata-specific version switcher in phase 2. (The current version switcher is only partially usable at the moment -- the links are only visible in dark mode, and dark mode is not available in Chrome or Safari -- so although this is a regression, it's not a major one.)

Screenshots from local build

Landing page

User guide section

Additional sections

How was this patch tested?

Tested locally.

Check all the applicable boxes

• I updated the documentation accordingly.
• All new and existing tests passed.
• All commits are signed-off.

Related PRs

flyteorg/flytesnacks#1726

Docs link

TK

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.31%. Comparing base (66ff152) to head (ed312f5).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5772      +/-   ##
==========================================
- Coverage   36.31%   36.31%   -0.01%     
==========================================
  Files        1304     1304              
  Lines      110048   110048              
==========================================
- Hits        39964    39963       -1     
- Misses      65928    65929       +1     
  Partials     4156     4156              

Flag	Coverage Δ
unittests-datacatalog	51.37% <ø> (ø)
unittests-flyteadmin	55.58% <ø> (ø)
unittests-flytecopilot	12.17% <ø> (ø)
unittests-flytectl	62.21% <ø> (ø)
unittests-flyteidl	7.12% <ø> (ø)
unittests-flyteplugins	53.35% <ø> (ø)
unittests-flytepropeller	41.93% <ø> (ø)
unittests-flytestdlib	55.35% <ø> (-0.03%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.