Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add version to header and use version specific documentation links #5504

Merged
merged 1 commit into from
Mar 19, 2022

Conversation

adamreeve
Copy link
Contributor

@adamreeve adamreeve commented Mar 17, 2022

Signed-off-by: Adam Reeve adreeve@gmail.com

What changes are proposed in this pull request?

Adds the mlflow version to the header and makes documentation links version specific. Fixes #3044.

The version is hard-coded in the Javascript source code. It looks like there's some automation that runs in Databricks Jenkins and updates the versions in the Python code already (eg. see #5417) so someone from Databricks will probably need to help out and configure this to also update the Javascript version if you're happy with this approach (I couldn't find any script responsible for this in the repo so I'm guessing it's configured elsewhere).

Alternatively, the UI could get the version from the Python tracking service API, but this approach seemed simpler seeing as the version is already present in multiple places in the source code.

The way I'm thinking this should work is that for development versions, the DOCS_VERSION remains at latest and only Version is updated, but when making a release, both Version and DOCS_VERSION are updated to the new version.

For putting the version in the header, I've taken inspiration from the documentation header and put it next to the logo:

header-with-version

How is this patch tested?

Ran Javascript tests, verified links work manually.

Does this PR change the documentation?

  • No. You can skip the rest of this section.
  • Yes. Make sure the changed pages / sections render correctly by following the steps below.
  1. Check the status of the ci/circleci: build_doc check. If it's successful, proceed to the
    next step, otherwise fix it.
  2. Click Details on the right to open the job page of CircleCI.
  3. Click the Artifacts tab.
  4. Click docs/build/html/index.html.
  5. Find the changed pages / sections and make sure they render correctly.

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

Added the Mlflow version to the header in the UI and changed documentation links to be specific to the installed Mlflow version.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

Interface

  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
  • area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
  • area/windows: Windows support

Language

  • language/r: R APIs and clients
  • language/java: Java APIs and clients
  • language/new: Proposals for new client languages

Integrations

  • integrations/azure: Azure and Azure ML integrations
  • integrations/sagemaker: SageMaker integrations
  • integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Signed-off-by: Adam Reeve <adreeve@gmail.com>
@github-actions github-actions bot added area/uiux Front-end, user experience, plotting, JavaScript, JavaScript dev server rn/feature Mention under Features in Changelogs. labels Mar 17, 2022
Copy link
Collaborator

@dbczumar dbczumar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks @adamreeve ! We'll absolutely update our MLflow release CI to account for bumping this version number prior to each release.

@sunishsheth2009 do you have any feedback?

Copy link
Collaborator

@sunishsheth2009 sunishsheth2009 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, hopefully we can extend this in future. Let us do some research on this

@dbczumar dbczumar merged commit fe9b4ed into mlflow:master Mar 19, 2022
@adamreeve adamreeve deleted the version_header branch March 21, 2022 00:56
erensahin pushed a commit to erensahin/mlflow that referenced this pull request Apr 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/uiux Front-end, user experience, plotting, JavaScript, JavaScript dev server rn/feature Mention under Features in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FR] UI should show the version and point to according documentation
3 participants