Closed AlexejPenner closed 3 months ago
[!IMPORTANT]
Review skipped
Auto reviews are disabled on this repository.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yaml
file in this repository. To trigger a single review, invoke the@coderabbitai review
command.You can disable this status message by setting the
reviews.review_status
tofalse
in the CodeRabbit configuration file.
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
This will be released in a subsequent version of ZenML, so when would there be a case for it to point to an older version of the docs? Just trying to understand why there are options for the docs URL now? @AlexejPenner
This will be released in a subsequent version of ZenML, so when would there be a case for it to point to an older version of the docs? Just trying to understand why there are options for the docs URL now? @AlexejPenner
Ok lets say we are at 0.58.2 and upgrade to 0.58.3. Part of the release flow is now to deprecate the 0.58.2 version of the docs and move it to the legacy docs domain. When somebody now runs their old 0.58.2 code and the docs_url property is loaded the local cove version 0.58.2 is no longer the latest (0.58.3) and so the legacy docs url is returned.
Wouldn't the person on 0.58.3 just get the new docs url which we set in code? Why is it getting an old docs url version? I might just be misunderstanding something really simple here, so feel free to ignore me.
Wouldn't the person on 0.58.3 just get the new docs url which we set in code? Why is it getting an old docs url version? I might just be misunderstanding something really simple here, so feel free to ignore me.
This is for people still running on an old version of zenml. Another example think 5 releases into the future. The code from this PR will be in as from 0.58.3 - if somebody does not upgrade to 0.65.9, their stack components might not have the latest and greatest attributes that were introduced up to this potential new latest version. So when they look at the docs for their stack components, we point to the docs at the right version for them
Describe changes
Stack component flavors have a "docs_url" property which is used in the frontend and CLI to point users in the right direction to get more context. With the recent changes to legacy docs, the package needs to return a different URL for the latest zenml version vs. all older versions.
Pre-requisites
Please ensure you have done the following:
develop
and the open PR is targetingdevelop
. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.Types of changes