flyteorg / flyte

Scalable and flexible workflow orchestration platform that seamlessly unifies data, ML and analytics stacks.
https://flyte.org
Apache License 2.0
5.17k stars 550 forks source link

DOC-252 Fix broken mermaid diagrams in docs #5467

Closed neverett closed 4 days ago

neverett commented 2 weeks ago

Why are the changes needed?

Closes https://github.com/flyteorg/flyte/issues/4864

What changes were proposed in this pull request?

Check all the applicable boxes

Related PRs

https://github.com/flyteorg/flyte/pull/5373

Docs link

TK

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 60.98%. Comparing base (bd2f9a8) to head (0cb167e).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #5467 +/- ## ========================================== - Coverage 61.93% 60.98% -0.96% ========================================== Files 611 793 +182 Lines 36463 51313 +14850 ========================================== + Hits 22582 31291 +8709 - Misses 11907 17136 +5229 - Partials 1974 2886 +912 ``` | [Flag](https://app.codecov.io/gh/flyteorg/flyte/pull/5467/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | Coverage Δ | | |---|---|---| | [unittests-datacatalog](https://app.codecov.io/gh/flyteorg/flyte/pull/5467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `69.31% <ø> (ø)` | | | [unittests-flyteadmin](https://app.codecov.io/gh/flyteorg/flyte/pull/5467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `58.64% <ø> (?)` | | | [unittests-flytecopilot](https://app.codecov.io/gh/flyteorg/flyte/pull/5467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `17.79% <ø> (ø)` | | | [unittests-flytectl](https://app.codecov.io/gh/flyteorg/flyte/pull/5467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `67.97% <ø> (ø)` | | | [unittests-flyteidl](https://app.codecov.io/gh/flyteorg/flyte/pull/5467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `79.04% <ø> (ø)` | | | [unittests-flyteplugins](https://app.codecov.io/gh/flyteorg/flyte/pull/5467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `61.84% <ø> (ø)` | | | [unittests-flytepropeller](https://app.codecov.io/gh/flyteorg/flyte/pull/5467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `57.32% <ø> (ø)` | | | [unittests-flytestdlib](https://app.codecov.io/gh/flyteorg/flyte/pull/5467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `65.82% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

neverett commented 2 weeks ago

@davidmirror-ops looks like docs tests are failing because the MMCloud plugin example page has a 404ing link. Here's a PR to remove and redirect the MMCloud plugin pages -- once it's merged, I can update the branch in this PR and the tests should pass.

neverett commented 2 weeks ago

@cosmicBboy I'm able to generate mermaid diagrams locally with the changes in this PR, but docs tests are failing with command '/home/docs/.asdf/shims/mmdc' cannot be run (needed for mermaid output), check the mermaid_cmd setting.

That is the location mmdc ends up installed in on the build server (see the readthedocs build logs), so I'm not sure what else to try -- any ideas?

cosmicBboy commented 1 week ago

As far I as I can tell the mmdc path will be different in readthedocs build env from the githin actions monodocs env.

I think the monodocs build GH workflow needs to be updated: https://github.com/flyteorg/flyte/blob/c10346d5bc07e37783c277f6d3bede301ae3ad99/flytectl/.github/workflows/monodocs_build.yml#L2

And then in conf.py the path needs to be set as an environment variable.

However, weird thing is that even in the readthedocs preview the mermaid diagrams aren't showing up: https://flyte--5467.org.readthedocs.build/en/5467/deployment/configuration/auth_appendix.html

cosmicBboy commented 1 week ago

trying out this smaller configuration change: https://github.com/flyteorg/flyte/pull/5498

neverett commented 4 days ago

Closing since this was fixed in https://github.com/flyteorg/flyte/pull/5498