From 0e2622dbebbcfb50f3f422879232ed8c4ddc8b64 Mon Sep 17 00:00:00 2001 From: Eric Li Dong Date: Mon, 22 Jan 2024 21:38:13 +0800 Subject: [PATCH 1/2] Add summary doc back --- docs/SUMMARY.md | 42 +++++++++++++++++++++ docs/user/generated/03_deploying_a_model.md | 2 +- 2 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 docs/SUMMARY.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 000000000..a4185622c --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,42 @@ +# Table of contents + +## Introduction + +* [Merlin Overview](/docs/user/generated/00_introduction.md) + +## User Guides + +* [Introduction](/docs/user/generated/01_getting_started.md) +* [Create a Model](/docs/user/generated/02_creating_a_model.md) + * [Custom Model](/docs/user/generated/model_types/01_custom_model.md) +* [Deploy a Model](/docs/user/generated/03_deploying_a_model.md) + * [Deploying a Model Version](/docs/user/generated/model_deployment/01_deploying_a_model_version.md) + * [Severing a Model Version](/docs/user/generated/model_deployment/02_serving_a_model_version.md) + * [Configuring Transformer](/docs/user/generated/model_deployment/03_configuring_transformers.md) + * [Standard Transformer](/docs/user/generated/model_deployment/transformer/01_standard_transformer.md) + * [Standard Transformer Expressions](/docs/user/generated/model_deployment/transformer/standard_transformer/01_standard_transformer_expressions.md) + * [Standard Transformer UPI](/docs/user/generated/model_deployment/transformer/standard_transformer/02_standard_transformer_upi.md) + * [Custom Transformer](/docs/user/generated/model_deployment/transformer/02_custom_transformer.md) + * [Redeploying a Model Version](/docs/user/generated/model_deployment/04_redeploying_a_model_version.md) +* [Deleting a Model](/docs/user/generated/04_deleting_a_model.md) +* [Configuring Alerts](/docs/user/generated/05_configuring_alerts.md) +* [Batch Prediction](/docs/user/generated/06_batch_prediction.md) +* [Model Sample Notebooks](/docs/user/generated/07_examples.md) + * [Deploy Standard Models](/docs/user/generated/examples/01_standard_model.md) + * [Deploy PyFunc Model](/docs/user/generated/examples/02_pyfunc_model.md) + * [Using Transformers](module/model/user/generated/examples/03_transformer.md) + * [Run Batch Prediction Job](/docs/user/generated/examples/04_batch_prediction.md) + * [Others examples on Models](/docs/user/generated/examples/05_others.md) +* [Limitations](/docs/user/generated/08_limitations.md) + +## Developer Guides + +* [Deploying Merlin](/README.md) + * [Local Development](/docs/developer/local-development.md) + * [End to End Tests](/docs/developer/e2e-test.md) +* [Architecture Overview](/docs/developer/architecture.md) + +## Maintainer Guides + +* [Installing Merlin](/docs/maintainer/generated/00_setting_up.md) +* [Troubleshooting Merlin](/docs/maintainer/generated/01_troubleshooting.md) diff --git a/docs/user/generated/03_deploying_a_model.md b/docs/user/generated/03_deploying_a_model.md index 81a13aa67..a26040ca2 100644 --- a/docs/user/generated/03_deploying_a_model.md +++ b/docs/user/generated/03_deploying_a_model.md @@ -9,4 +9,4 @@ To learn about deploying a model, please visit the following docs. {% page-ref page="./model_deployment/03_configuring_transformers.md" %} -{% page-ref page="./model_deployment/04_redeploying_a_model_version.md" %} \ No newline at end of file +{% page-ref page="./model_deployment/04_redeploying_a_model_version.md" %} From f00216c8b26285c392dc8b1e7fa589be11224498 Mon Sep 17 00:00:00 2001 From: Eric Li Dong Date: Mon, 22 Jan 2024 22:02:56 +0800 Subject: [PATCH 2/2] Fix markdown reference --- docs/SUMMARY.md | 56 ++++++++++++++++++++++++------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index a4185622c..7faf2b789 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -2,41 +2,41 @@ ## Introduction -* [Merlin Overview](/docs/user/generated/00_introduction.md) +* [Merlin Overview](/user/generated/00_introduction.md) ## User Guides -* [Introduction](/docs/user/generated/01_getting_started.md) -* [Create a Model](/docs/user/generated/02_creating_a_model.md) - * [Custom Model](/docs/user/generated/model_types/01_custom_model.md) -* [Deploy a Model](/docs/user/generated/03_deploying_a_model.md) - * [Deploying a Model Version](/docs/user/generated/model_deployment/01_deploying_a_model_version.md) - * [Severing a Model Version](/docs/user/generated/model_deployment/02_serving_a_model_version.md) - * [Configuring Transformer](/docs/user/generated/model_deployment/03_configuring_transformers.md) - * [Standard Transformer](/docs/user/generated/model_deployment/transformer/01_standard_transformer.md) - * [Standard Transformer Expressions](/docs/user/generated/model_deployment/transformer/standard_transformer/01_standard_transformer_expressions.md) - * [Standard Transformer UPI](/docs/user/generated/model_deployment/transformer/standard_transformer/02_standard_transformer_upi.md) - * [Custom Transformer](/docs/user/generated/model_deployment/transformer/02_custom_transformer.md) - * [Redeploying a Model Version](/docs/user/generated/model_deployment/04_redeploying_a_model_version.md) -* [Deleting a Model](/docs/user/generated/04_deleting_a_model.md) -* [Configuring Alerts](/docs/user/generated/05_configuring_alerts.md) -* [Batch Prediction](/docs/user/generated/06_batch_prediction.md) -* [Model Sample Notebooks](/docs/user/generated/07_examples.md) - * [Deploy Standard Models](/docs/user/generated/examples/01_standard_model.md) - * [Deploy PyFunc Model](/docs/user/generated/examples/02_pyfunc_model.md) - * [Using Transformers](module/model/user/generated/examples/03_transformer.md) - * [Run Batch Prediction Job](/docs/user/generated/examples/04_batch_prediction.md) - * [Others examples on Models](/docs/user/generated/examples/05_others.md) -* [Limitations](/docs/user/generated/08_limitations.md) +* [Introduction](/user/generated/01_getting_started.md) +* [Create a Model](/user/generated/02_creating_a_model.md) + * [Custom Model](/user/generated/model_types/01_custom_model.md) +* [Deploy a Model](/user/generated/03_deploying_a_model.md) + * [Deploying a Model Version](/user/generated/model_deployment/01_deploying_a_model_version.md) + * [Severing a Model Version](/user/generated/model_deployment/02_serving_a_model_version.md) + * [Configuring Transformer](/user/generated/model_deployment/03_configuring_transformers.md) + * [Standard Transformer](/user/generated/model_deployment/transformer/01_standard_transformer.md) + * [Standard Transformer Expressions](/user/generated/model_deployment/transformer/standard_transformer/01_standard_transformer_expressions.md) + * [Standard Transformer UPI](/user/generated/model_deployment/transformer/standard_transformer/02_standard_transformer_upi.md) + * [Custom Transformer](/user/generated/model_deployment/transformer/02_custom_transformer.md) + * [Redeploying a Model Version](/user/generated/model_deployment/04_redeploying_a_model_version.md) +* [Deleting a Model](/user/generated/04_deleting_a_model.md) +* [Configuring Alerts](/user/generated/05_configuring_alerts.md) +* [Batch Prediction](/user/generated/06_batch_prediction.md) +* [Model Sample Notebooks](/user/generated/07_examples.md) + * [Deploy Standard Models](/user/generated/examples/01_standard_model.md) + * [Deploy PyFunc Model](/user/generated/examples/02_pyfunc_model.md) + * [Using Transformers](/user/generated/examples/03_transformer.md) + * [Run Batch Prediction Job](/user/generated/examples/04_batch_prediction.md) + * [Others examples on Models](/user/generated/examples/05_others.md) +* [Limitations](/user/generated/08_limitations.md) ## Developer Guides * [Deploying Merlin](/README.md) - * [Local Development](/docs/developer/local-development.md) - * [End to End Tests](/docs/developer/e2e-test.md) -* [Architecture Overview](/docs/developer/architecture.md) + * [Local Development](/developer/local-development.md) + * [End to End Tests](/developer/e2e-test.md) +* [Architecture Overview](/developer/architecture.md) ## Maintainer Guides -* [Installing Merlin](/docs/maintainer/generated/00_setting_up.md) -* [Troubleshooting Merlin](/docs/maintainer/generated/01_troubleshooting.md) +* [Installing Merlin](/maintainer/generated/00_setting_up.md) +* [Troubleshooting Merlin](/maintainer/generated/01_troubleshooting.md)