Convert CHANGELOG.rst to markdown
#5455
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
harupy
force-pushed
the
convert-changelog-to-markdown
branch
from
5887e4e
to
0fda395
Compare
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
harupy
commented
Mar 7, 2022
CHANGELOG.md
Outdated
Comment on lines
1066
to
1045
| - [Python][CLI] Mark ``azureml.build_image`` as experimental (#1222, #1233 @sueann) | ||
| - [Projects] Fix bug not sharing `SQLite` database file with Docker container (#1347, @tomasatdatabricks; #1375, @aarondav) | ||
| - [Java] Mark `sendPost` and `sendGet` as experimental (#1186, @aarondav) | ||
| - [Python][cli] Mark `azureml.build_image` as experimental (#1222, #1233 @sueann) |
There was a problem hiding this comment.
prettier automatically lower-cases link keys:
prettier/prettier#7118
There was a problem hiding this comment.
One way to prevent this is to wrap the tag with backticks:
`[Python][CLI]` Mark ...
or avoid using the [A][B] syntax:
[Python/CLI]
There was a problem hiding this comment.
so let's change it back to [CLI] ?
There was a problem hiding this comment.
@WeichenXu123 If we use [Python][CLI], we can't apply auto-formatting with prettier, which I think is incovenient.
There was a problem hiding this comment.
got it. I think using either [Python][CLI] or [Python/CLI] is fine.
There was a problem hiding this comment.
+1 to the hybridized [Python/<PascalCase/camelcase>] as needed so that link references are consistent and legible.
WeichenXu123
approved these changes
Mar 7, 2022
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
erensahin
pushed a commit
to erensahin/mlflow
that referenced
this pull request
Apr 11, 2022
* Convert CHANGELOG.rst to markdown Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * fix link Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * fix formatting Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * fix cross_val Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * fix link keys Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: harupy 17039389+harupy@users.noreply.github.com
What changes are proposed in this pull request?
Convert
CHANGELOG.rstto markdown.Motivation
Follow-up tasks
CHANGELOG.How is this patch tested?
Manual verification.
Does this PR change the documentation?
ci/circleci: build_doccheck. If it's successful, proceed to thenext step, otherwise fix it.
Detailson the right to open the job page of CircleCI.Artifactstab.docs/build/html/index.html.Release Notes
Is this a user-facing change?
(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)
What component(s), interfaces, languages, and integrations does this PR affect?
Components
area/artifacts: Artifact stores and artifact loggingarea/build: Build and test infrastructure for MLflowarea/docs: MLflow documentation pagesarea/examples: Example codearea/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registryarea/models: MLmodel format, model serialization/deserialization, flavorsarea/projects: MLproject format, project running backendsarea/scoring: MLflow Model server, model deployment tools, Spark UDFsarea/server-infra: MLflow Tracking server backendarea/tracking: Tracking Service, tracking client APIs, autologgingInterface
area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Modelsarea/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registryarea/windows: Windows supportLanguage
language/r: R APIs and clientslanguage/java: Java APIs and clientslanguage/new: Proposals for new client languagesIntegrations
integrations/azure: Azure and Azure ML integrationsintegrations/sagemaker: SageMaker integrationsintegrations/databricks: Databricks integrationsHow should the PR be classified in the release notes? Choose one:
rn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notes