Skip to content

Commit

Permalink
Adding back SUMMARY.md file (#520)
Browse files Browse the repository at this point in the history
<!--  Thanks for sending a pull request!  Here are some tips for you:

1. Run unit tests and ensure that they are passing
2. If your change introduces any API changes, make sure to update the
e2e tests
3. Make sure documentation is updated for your PR!

-->
# Description
<!-- Briefly describe the motivation for the change. Please include
illustrations where appropriate. -->
In the [recent PR to
Merlin](1664f3d),
the SUMMARY.md file is removed from the docs. While it does not affect
the overall CaraML docs on gitbook, this Merlin specific MD file was
added to make sure Merlin docs can work standalone with gitbook, similar
to how Turing and Turing XP docs are gitbook compatible. e.g. Users who
uses Merlin/Turing/Turing XP alone, outside of the CaraML setting, can
also use gitbook to refer to the docs.

# Modifications
<!-- Summarize the key code changes. -->
Adding back the SUMMARY.md file and updated to conform with the new
document structure.

# Tests
<!-- Besides the existing / updated automated tests, what specific
scenarios should be tested? Consider the backward compatibility of the
changes, whether corner cases are covered, etc. Please describe the
tests and check the ones that have been completed. Eg:
- [x] Deploying new and existing standard models
- [ ] Deploying PyFunc models
-->

# 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

# Release Notes
<!--
Does this PR introduce a user-facing change?
If no, just write "NONE" in the release-note block below.
If yes, a release note is required. Enter your extended release note in
the block below.
If the PR requires additional action from users switching to the new
release, include the string "action required".

For more information about release notes, see kubernetes' guide here:
http://git.k8s.io/community/contributors/guide/release-notes.md
-->

```release-note

```
  • Loading branch information
eric-lidong authored Jan 23, 2024
1 parent efbe83f commit 52dc4ec
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
42 changes: 42 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Table of contents

## Introduction

* [Merlin Overview](/user/generated/00_introduction.md)

## User Guides

* [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](/developer/local-development.md)
* [End to End Tests](/developer/e2e-test.md)
* [Architecture Overview](/developer/architecture.md)

## Maintainer Guides

* [Installing Merlin](/maintainer/generated/00_setting_up.md)
* [Troubleshooting Merlin](/maintainer/generated/01_troubleshooting.md)
2 changes: 1 addition & 1 deletion docs/user/generated/03_deploying_a_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}
{% page-ref page="./model_deployment/04_redeploying_a_model_version.md" %}

0 comments on commit 52dc4ec

Please sign in to comment.