Skip to content

Commit 4d7477c

Browse files
committed
[Docs] Refine quick start guide for contributing models by restructuring steps and clarifying instructions
Signed-off-by: leecalcote <[email protected]>
1 parent e58135e commit 4d7477c

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

docs/pages/project/contributing/contributing-models-quick-start.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,14 @@ The following instructions are a no-fluff guide to creating your own Meshery Mod
2626
### Create a Model Definition
2727

2828
1. In your meshery/meshery fork, navigate to `mesheryctl/templates/templates-csvs` directory.
29-
1. Edit the `models.csv` file to include your model definition.
30-
1. [Annotations] For models that contain annotation components, edit the `components.csv` file to include your component definitions.
31-
1. Create a new model by executing the following command:
32-
{% capture code_content %}$ mesheryctl registry generate --directory templates-csvs{% endcapture %}
33-
{% include code.html code=code_content %}
34-
1. Review the generated components inside of the `server/meshmodel` directory under your model's name.
35-
1. Import your model definition into a Meshery Server.
36-
{% capture code_content %}$ mesheryctl model import -f `server/meshmodel/<model-name>`{% endcapture %}
37-
{% include code.html code=code_content %}
38-
1. You can deploy Meshery Server using the following command:
39-
{% capture code_content %}$ mesheryctl system start{% endcapture %}
29+
2. Edit the `models.csv` file to include your model definition.
30+
1. [Annotation-only Components] For models that contain annotation components, edit the `components.csv` file to include your component definitions.
31+
3. Create a new model by executing the following command:
32+
{% capture code_content %}$ mesheryctl registry generate --directory templates-csvs{% endcapture %}
4033
{% include code.html code=code_content %}
41-
or use the [Meshery Playground](https://playground.meshery.io).
42-
1. Verify that your model is displayed in the Meshery UI under Settings->Registry->Models.
34+
4. Review the generated components inside of the `server/meshmodel` directory under your model's name.
35+
5. Import your model definition into a Meshery Server (optionally, use the [Meshery Playground](https://playground.meshery.io)).
36+
6. Verify that your model is displayed in the Meshery UI under Settings->Registry->Models.
4337

4438
**Congratulations! You have successfully created a new model.**
4539

0 commit comments

Comments
 (0)