-
Notifications
You must be signed in to change notification settings - Fork 834
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add demo into videos on website (#1581)
* add demo into videos on website * update pull_request_template and ask PR raiser to add samples if adding new features
- Loading branch information
1 parent
7c34fc4
commit a6a2718
Showing
2 changed files
with
46 additions
and
6 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,37 @@ | ||
# Summary | ||
<!-- 🚨 We recommend pull requests be filed from a non-master branch on a repository fork (e.g. <username>:fix-xxx). 🚨 --> | ||
|
||
## Related Issues/PRs | ||
|
||
<!-- | ||
Please reference any related feature requests, issues, or PRs here. For example, `#123`. To automatically close the referenced items when this PR is merged, please use a closing keyword (close, fix, or resolve). For example, `Close #123`. See https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue for more information. | ||
--> | ||
#xxx | ||
|
||
## What changes are proposed in this pull request? | ||
|
||
_Briefly describe the changes included in this Pull Request._ | ||
|
||
# Tests | ||
## How is this patch tested? | ||
|
||
<!-- | ||
If you're unsure about what to test, where to add tests, or how to run tests, please feel free to ask. We'd be happy to help. | ||
--> | ||
- [ ] I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works. | ||
|
||
## Does this PR change any dependencies? | ||
|
||
- [ ] No. You can skip this section. | ||
- [ ] Yes. Make sure the dependencies are resolved correctly, and list changes here. | ||
|
||
_Describe what tests have you performed to validate your changes before submitting the Pull Request. Use 'N/A' if not applicable._ | ||
## Does this PR add a new feature? If so, have you added samples on website? | ||
|
||
# Dependency changes | ||
- [ ] No. You can skip this section. | ||
- [ ] Yes. Make sure you have added samples following below steps. | ||
|
||
_If you needed to make any changes to dependencies of this project, please describe them here._ | ||
1. Find the corresponding markdown file for your new feature in `website/docs/documentation` folder. | ||
Make sure you choose the correct class `estimators/transformers` and namespace. | ||
2. Follow the pattern in markdown file and add another section for your new API, including pyspark, scala (and .NET potentially) samples. | ||
3. Make sure the `DocTable` points to correct API link. | ||
4. Navigate to website folder, and run `yarn run start` to make sure the website renders correctly. | ||
5. Don't forget to add `<!--pytest-codeblocks:cont-->` before each python code blocks to enable auto-tests for python samples. | ||
6. Make sure the `WebsiteSamplesTests` job pass in the pipeline. |
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