Add instructions to preview documentation on CircleCI in pull request template#5031
Merged
Conversation
Signed-off-by: harupy <hkawamura0130@gmail.com>
harupy
commented
Nov 9, 2021
Comment on lines
+9
to
+20
| ## Does this PR affect the documentation? | ||
|
|
||
| - [ ] No. You can skip the rest of this section. | ||
| - [ ] Yes. Make sure the affected pages / sections render correctly by following the steps below. | ||
|
|
||
| Steps: | ||
|
|
||
| 1. Make sure the status of the `ci/circleci: build_doc` check is successful. If no, fix it. | ||
| 2. Click `Details` to open the job page of CircleCI. | ||
| 3. Click the `Artifacts` tab. | ||
| 4. Click `docs/build/html/index.html`. | ||
| 5. Find the affect pages / sections and make sure they render correctly. |
Member
Author
There was a problem hiding this comment.
This section should look like this:
liangz1
reviewed
Nov 9, 2021
|
|
||
| (Details) | ||
|
|
||
| ## Does this PR affect the documentation? |
There was a problem hiding this comment.
minor: What about using "update" or "change" instead of "affect"? That would be more explicit :)
Member
Author
There was a problem hiding this comment.
"change" sounds good to me :)
|
|
||
| Steps: | ||
|
|
||
| 1. Check the status of the `ci/circleci: build_doc` check. If it's successful, proceed to the |
There was a problem hiding this comment.
Does this test need to be manually started, or does it always run, or is it automatically triggered whenever a docs change is detected?
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
27 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 hkawamura0130@gmail.com
What changes are proposed in this pull request?
Add instructions to preview the documentation on CircleCI in the pull request template.
How is this patch tested?
NA
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