From fe2e7c5457b3aba908ae04338eb9f52328dd3669 Mon Sep 17 00:00:00 2001 From: Krithika Sundararajan Date: Thu, 21 Dec 2023 08:32:13 +0800 Subject: [PATCH] Miscellaneous Doc updates (#510) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **What this PR does / why we need it**: This PR implements a few small changes: 1. `.github/release.yml` - Adds a configuration for categorising changes in automatically generated release notes ([ref](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#example-configurations)) 2. `.github/workflows/pr-checks.yaml` - Makes labelling PRs mandatory ([ref](https://github.com/marketplace/actions/require-labels)). The full list of labels are [here](https://github.com/caraml-dev/merlin/labels). Only a subset of them, defined in the workflow file, are applicable to PRs. 3. Renames / reorganises the docs: ``` . ├── README.md ├── SUMMARY.md ├── developer // For dev docs ├── diagrams ├── images ├── maintainer // For maintainer docs └── user // For user docs ``` 4. Update the PR template to make the comments slightly more concise and add more sections The contents of the docs will be updated in a separate PR. **Which issue(s) this PR fixes**: None **Does this PR introduce a user-facing change?**: ```release-note NONE ``` **Checklist** - [ ] Added unit test, integration, and/or e2e tests - [ ] Tested locally - [x] Updated documentation - [ ] Update Swagger spec if the PR introduce API changes - [ ] Regenerated Golang and Python client if the PR introduce API changes --- .github/pull_request_template.md | 33 +++++------ .github/release.yml | 18 ++++++ .github/workflows/pr-checks.yaml | 16 ++++++ docs/README.md | 11 ++++ docs/SUMMARY.md | 53 +++++++++--------- docs/{dev-guide => developer}/architecture.md | 4 +- .../deploying-merlin/README.md | 0 .../deploying-merlin/local_development.md | 0 docs/{reference => developer}/e2e-test.md | 0 docs/getting-started/README.md | 13 ----- docs/maintainer/.gitkeep | 0 .../autoscaling_policy.md | 0 docs/{user-guide => user}/basics.md | 0 docs/{user-guide => user}/batch_prediction.md | 0 .../configure_standard_transformer.gif | Bin .../{ => user}/connecting-to-merlin/README.md | 0 .../connecting-to-merlin/merlin-cli.md | 0 .../connecting-to-merlin/python-sdk.md | 0 docs/{user-guide => user}/custom_model.md | 0 .../custom_transformer.md | 0 docs/{user-guide => user}/deployment_mode.md | 0 docs/{user-guide => user}/examples/README.md | 0 .../examples/batch_prediction.md | 0 docs/{user-guide => user}/examples/others.md | 0 .../examples/pyfunc_model.md | 0 .../examples/standard_model.md | 0 .../examples/transformer.md | 0 docs/{reference => user}/limitations.md | 0 docs/{user-guide => user}/model.md | 0 docs/{user-guide => user}/model_deletion.md | 0 .../model_deployment_serving.md | 0 docs/{user-guide => user}/model_endpoint.md | 0 docs/{user-guide => user}/model_version.md | 0 .../model_version_deletion.md | 0 .../model_version_endpoint.md | 0 .../standard_transformer.md | 0 .../standard_transformer_upi.md | 0 docs/{user-guide => user}/transformer.md | 0 .../transformer_expressions.md | 0 39 files changed, 90 insertions(+), 58 deletions(-) create mode 100644 .github/release.yml create mode 100644 .github/workflows/pr-checks.yaml rename docs/{dev-guide => developer}/architecture.md (94%) rename docs/{dev-guide => developer}/deploying-merlin/README.md (100%) rename docs/{dev-guide => developer}/deploying-merlin/local_development.md (100%) rename docs/{reference => developer}/e2e-test.md (100%) delete mode 100644 docs/getting-started/README.md create mode 100644 docs/maintainer/.gitkeep rename docs/{user-guide => user}/autoscaling_policy.md (100%) rename docs/{user-guide => user}/basics.md (100%) rename docs/{user-guide => user}/batch_prediction.md (100%) rename docs/{user-guide => user}/configure_standard_transformer.gif (100%) rename docs/{ => user}/connecting-to-merlin/README.md (100%) rename docs/{ => user}/connecting-to-merlin/merlin-cli.md (100%) rename docs/{ => user}/connecting-to-merlin/python-sdk.md (100%) rename docs/{user-guide => user}/custom_model.md (100%) rename docs/{user-guide => user}/custom_transformer.md (100%) rename docs/{user-guide => user}/deployment_mode.md (100%) rename docs/{user-guide => user}/examples/README.md (100%) rename docs/{user-guide => user}/examples/batch_prediction.md (100%) rename docs/{user-guide => user}/examples/others.md (100%) rename docs/{user-guide => user}/examples/pyfunc_model.md (100%) rename docs/{user-guide => user}/examples/standard_model.md (100%) rename docs/{user-guide => user}/examples/transformer.md (100%) rename docs/{reference => user}/limitations.md (100%) rename docs/{user-guide => user}/model.md (100%) rename docs/{user-guide => user}/model_deletion.md (100%) rename docs/{user-guide => user}/model_deployment_serving.md (100%) rename docs/{user-guide => user}/model_endpoint.md (100%) rename docs/{user-guide => user}/model_version.md (100%) rename docs/{user-guide => user}/model_version_deletion.md (100%) rename docs/{user-guide => user}/model_version_endpoint.md (100%) rename docs/{user-guide => user}/standard_transformer.md (100%) rename docs/{user-guide => user}/standard_transformer_upi.md (100%) rename docs/{user-guide => user}/transformer.md (100%) rename docs/{user-guide => user}/transformer_expressions.md (100%) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2580f6807..339b7d07a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,20 +5,29 @@ 3. Make sure documentation is updated for your PR! --> +# Description + -**What this PR does / why we need it**: - +# Modifications + -**Which issue(s) this PR fixes**: - -Fixes # +# Checklist +- [ ] Added PR label +- [ ] Added unit test, integration, and/or e2e tests +- [ ] Tested locally +- [ ] Updated documentation +- [ ] Update Swagger spec if the PR introduce API changes +- [ ] Regenerated Golang and Python client if the PR introduces API changes -**Does this PR introduce a user-facing change?**: +# Release Notes - diff --git a/docs/maintainer/.gitkeep b/docs/maintainer/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/docs/user-guide/autoscaling_policy.md b/docs/user/autoscaling_policy.md similarity index 100% rename from docs/user-guide/autoscaling_policy.md rename to docs/user/autoscaling_policy.md diff --git a/docs/user-guide/basics.md b/docs/user/basics.md similarity index 100% rename from docs/user-guide/basics.md rename to docs/user/basics.md diff --git a/docs/user-guide/batch_prediction.md b/docs/user/batch_prediction.md similarity index 100% rename from docs/user-guide/batch_prediction.md rename to docs/user/batch_prediction.md diff --git a/docs/user-guide/configure_standard_transformer.gif b/docs/user/configure_standard_transformer.gif similarity index 100% rename from docs/user-guide/configure_standard_transformer.gif rename to docs/user/configure_standard_transformer.gif diff --git a/docs/connecting-to-merlin/README.md b/docs/user/connecting-to-merlin/README.md similarity index 100% rename from docs/connecting-to-merlin/README.md rename to docs/user/connecting-to-merlin/README.md diff --git a/docs/connecting-to-merlin/merlin-cli.md b/docs/user/connecting-to-merlin/merlin-cli.md similarity index 100% rename from docs/connecting-to-merlin/merlin-cli.md rename to docs/user/connecting-to-merlin/merlin-cli.md diff --git a/docs/connecting-to-merlin/python-sdk.md b/docs/user/connecting-to-merlin/python-sdk.md similarity index 100% rename from docs/connecting-to-merlin/python-sdk.md rename to docs/user/connecting-to-merlin/python-sdk.md diff --git a/docs/user-guide/custom_model.md b/docs/user/custom_model.md similarity index 100% rename from docs/user-guide/custom_model.md rename to docs/user/custom_model.md diff --git a/docs/user-guide/custom_transformer.md b/docs/user/custom_transformer.md similarity index 100% rename from docs/user-guide/custom_transformer.md rename to docs/user/custom_transformer.md diff --git a/docs/user-guide/deployment_mode.md b/docs/user/deployment_mode.md similarity index 100% rename from docs/user-guide/deployment_mode.md rename to docs/user/deployment_mode.md diff --git a/docs/user-guide/examples/README.md b/docs/user/examples/README.md similarity index 100% rename from docs/user-guide/examples/README.md rename to docs/user/examples/README.md diff --git a/docs/user-guide/examples/batch_prediction.md b/docs/user/examples/batch_prediction.md similarity index 100% rename from docs/user-guide/examples/batch_prediction.md rename to docs/user/examples/batch_prediction.md diff --git a/docs/user-guide/examples/others.md b/docs/user/examples/others.md similarity index 100% rename from docs/user-guide/examples/others.md rename to docs/user/examples/others.md diff --git a/docs/user-guide/examples/pyfunc_model.md b/docs/user/examples/pyfunc_model.md similarity index 100% rename from docs/user-guide/examples/pyfunc_model.md rename to docs/user/examples/pyfunc_model.md diff --git a/docs/user-guide/examples/standard_model.md b/docs/user/examples/standard_model.md similarity index 100% rename from docs/user-guide/examples/standard_model.md rename to docs/user/examples/standard_model.md diff --git a/docs/user-guide/examples/transformer.md b/docs/user/examples/transformer.md similarity index 100% rename from docs/user-guide/examples/transformer.md rename to docs/user/examples/transformer.md diff --git a/docs/reference/limitations.md b/docs/user/limitations.md similarity index 100% rename from docs/reference/limitations.md rename to docs/user/limitations.md diff --git a/docs/user-guide/model.md b/docs/user/model.md similarity index 100% rename from docs/user-guide/model.md rename to docs/user/model.md diff --git a/docs/user-guide/model_deletion.md b/docs/user/model_deletion.md similarity index 100% rename from docs/user-guide/model_deletion.md rename to docs/user/model_deletion.md diff --git a/docs/user-guide/model_deployment_serving.md b/docs/user/model_deployment_serving.md similarity index 100% rename from docs/user-guide/model_deployment_serving.md rename to docs/user/model_deployment_serving.md diff --git a/docs/user-guide/model_endpoint.md b/docs/user/model_endpoint.md similarity index 100% rename from docs/user-guide/model_endpoint.md rename to docs/user/model_endpoint.md diff --git a/docs/user-guide/model_version.md b/docs/user/model_version.md similarity index 100% rename from docs/user-guide/model_version.md rename to docs/user/model_version.md diff --git a/docs/user-guide/model_version_deletion.md b/docs/user/model_version_deletion.md similarity index 100% rename from docs/user-guide/model_version_deletion.md rename to docs/user/model_version_deletion.md diff --git a/docs/user-guide/model_version_endpoint.md b/docs/user/model_version_endpoint.md similarity index 100% rename from docs/user-guide/model_version_endpoint.md rename to docs/user/model_version_endpoint.md diff --git a/docs/user-guide/standard_transformer.md b/docs/user/standard_transformer.md similarity index 100% rename from docs/user-guide/standard_transformer.md rename to docs/user/standard_transformer.md diff --git a/docs/user-guide/standard_transformer_upi.md b/docs/user/standard_transformer_upi.md similarity index 100% rename from docs/user-guide/standard_transformer_upi.md rename to docs/user/standard_transformer_upi.md diff --git a/docs/user-guide/transformer.md b/docs/user/transformer.md similarity index 100% rename from docs/user-guide/transformer.md rename to docs/user/transformer.md diff --git a/docs/user-guide/transformer_expressions.md b/docs/user/transformer_expressions.md similarity index 100% rename from docs/user-guide/transformer_expressions.md rename to docs/user/transformer_expressions.md