diff --git a/docs/howto/getting_started_markdown.md b/docs/howto/getting-started-markdown.md similarity index 54% rename from docs/howto/getting_started_markdown.md rename to docs/howto/getting-started-markdown.md index b335ef0..a0ad8ab 100644 --- a/docs/howto/getting_started_markdown.md +++ b/docs/howto/getting-started-markdown.md @@ -132,10 +132,10 @@ can be changed at any time to any Python file as long as it contains a `Plugin` class that registers with the Alteryx Core SDK. - For a detailed explanation of the Config.xml file, go to [Tool - Configurations.](../references/config_xml_markdown.md). + Configurations.](../references/config-xml-markdown.md). - For information on the main.py file within your Ayx Plugin Tool, go to [Plugin Code - Overview.](../references/plugin_code_markdown.md). + Overview.](../references/plugin-code-markdown.md). ### Configuration Panel GUI @@ -146,6 +146,137 @@ development. For more information on Configuration Panel GUI development, go to [Alteryx UI SDK](https://help.alteryx.com/developer-help/ayx-ui-sdk). +## Platform SDK Quickstart Guide + +#### Python SDK v2 + +The steps below illustrate how to use the latest developer tools to +create a custom plugin or tool for use in Alteryx. For more information +about new SDKs and their usage within Alteryx, please visit [Platform SDK](../references/platform-sdk.md). + +### Requirements and Prerequisites + +Before you get started, make sure that these items are installed on your +machine: + +- Microsoft Windows 7 or later (64-bit) +- Alteryx Designer Version 2021.2\* +- Python Version 3.8.5 +- [pip](https://pypi.org/) (automatically installed with Python 3.8.5) +- [node](https://nodejs.org/en/download/) [14](https://nodejs.org/en/blog/release/v14.17.3/) +- [Git](https://git-scm.com/downloads) + +\*Alteryx Designer version 2021.4 or greater is required to use the Alteryx Python +SDK v2.0.0. + +### CLI + +The AYX Plugin CLI provides you with a set of utilities to manage your +plugin and is a great starting point for building a tool. AYX Python SDK +installation is also covered in this section. + +[Follow these steps to get started with the CLI.](#install-the-package). + +For more information about the CLI, please visit the [reference +documents](../references/ayx-plugin-cli.md). + +### UI SDK + +The UI SDK consists of 2 pieces. + +- The 1st piece is a React-based [component + library](https://alteryx.github.io/alteryx-ui/) + that enables you to build the interface for your tool or plugin. +- The 2nd piece is a [communication + bridge](https://alteryx.github.io/react-comms/) + that lets you interact with Alteryx Designer and persists the values + that you want to save between runs of a workflow, clicking on and + off a tool. These are also the values that are available to the + engine (back end) of your tool. + +For the real-time Dev Harness that assists in tool UI development, refer to [Dev Harness.](https://github.com/alteryx/dev-harness) + +Follow these steps to get started with the UI SDK: + +1. To start on the user interface of your project, navigate to the + folder that was created for your workspace in the last step of the + CLI section above. In this workspace folder, there is a UI directory + for the workspace. There is a folder inside of this directory with + the same name as the plugin you created. +2. Navigate to [\[workspace directory\]\\ui\\\[plugin + name\]\\src\\src]{.path} for the tool you are working on. +3. Open the index.tsx file. This is the primary + [React](https://reactjs.org/) + file for the tool UI. +4. Make a change to the file. For example, edit the text of a tag, or + add a [new + component](https://alteryx.github.io/alteryx-ui/) + or HTML element to the page. +5. Save the file. +6. For a quick preview of your tool in a browser, run this command:\ + \ + `npm run start` +7. To view your tool in Alteryx Designer, run this command from the + root workspace directory. This command builds and installs your + plugin into Designer.\ + \ + `ayx_plugin_cli designer-install` + +Open Alteryx Designer, search for your tool, place it on the canvas, and +view the changes. + +For more information about the UI SDK, please visit the [reference +documents](https://alteryx.github.io/alteryx-ui/). + + +### Python SDK + + +The Python SDK defines the way that you should create the engine/back +end/runtime of your tool. The back end also receives the configuration +values that were created by the front end of the tool in the UI SDK +section. + +Follow these steps to get started with the Python SDK: + +1. To start on the engine or runtime of your project, navigate to the + folder that was created for your workspace in the last step of the + CLI section above. In this workspace folder, there is a back-end + directory for the workspace. +2. Navigate to [\[workspace directory\]\\backend\\ayx_plugins\\\[plugin + name\].py]{.path} for the tool you are editing. +3. Make changes to the file. +4. Save the file. +5. Run this command from the root workspace directory. This builds and + installs your plugin into Alteryx Designer.\ + \ + `ayx_plugin_cli designer-install` + +Open Alteryx Designer, search for your tool, place it on the canvas, and +view the changes. + +For more information about the Python SDK, please go to the [reference +documents](../references/platform-sdk.md) or access the full [Python +SDK documentation](https://alteryx.github.io/ayx-python-sdk/index.html). +You can also access this documentation locally via this command: + +`ayx_python_sdk docs` + + +### Troubleshooting + +- If you get a workflow error that says 'Can\'t find plugin + \"SdkEnginePlugin.dll\"\', or \"This tool is only supported in the + AMP Engine. Please enable AMP to use this tool.\", [enable the AMP + engine](https://help.alteryx.com/20223/designer/alteryx-amp-engine) + for the workflow. +- If your tool panel does not render or shows a blank screen, [enable + Chrome Developer + Tools](https://help.alteryx.com/developer-help/html-developer-tools). + Now, when you select your tool a Chrome debugger is presented and + you can see any errors for the tool interface. + + ------------------------------------------------------------------------ ### Glossary diff --git a/docs/howto/platform-sdk-quickstart-guide.md b/docs/howto/platform-sdk-quickstart-guide.md deleted file mode 100644 index e39956e..0000000 --- a/docs/howto/platform-sdk-quickstart-guide.md +++ /dev/null @@ -1,172 +0,0 @@ -# Platform SDK Quickstart Guide - -#### Python SDK v2 - -The steps below illustrate how to use the latest developer tools to -create a custom plugin or tool for use in Alteryx. For more information -about new SDKs and their usage within Alteryx, please visit [Platform -SDK](../references/platform-sdk.md). - -### Requirements and Prerequisites - -Before you get started, make sure that these items are installed on your -machine: - -- Microsoft Windows 7 or Later (64-bit) -- Alteryx Designer Version 2021.2\* -- Python Version 3.8.5 -- [pip](https://pypi.org/) (automatically installed with Python 3.8.5) -- [node](https://nodejs.org/en/download/) [14](https://nodejs.org/en/blog/release/v14.17.3/) -- [Git](https://git-scm.com/downloads) - -\*Alteryx Designer version 2021.4 or greater is required to use the Alteryx Python -SDK v2.0.0. - -### CLI - -The AYX Plugin CLI provides you with a set of utilities to manage your -plugin and is a great starting point for building a tool. AYX Python SDK -installation is also covered in this section. - -Follow these steps to get started with the CLI: - -1. Run this command to install the AYX Plugin CLI:\ - \ - `pip install ayx-plugin-cli`\ -   -2. To verify that you installed the CLI properly, run this command:\ - \ - `ayx_plugin_cli version`\ - \ - If the installation was successful the above command returns the - version number. If the CLI was not installed properly, the - `ayx_plugin_cli` command is not recognized in the terminal, and your - terminal reflects that.\ -   -3. Run this command to install the AYX Python SDK:\ - \ - `pip install ayx-python-sdk`\ - \ - *(Optional) Create a new directory to house all of your workspaces - and plugins, and continue the steps in this guide from the new - directory. This helps keep your folder structure clean.*\ -   -4. Once the installation is successful, run this command to create a - workspace:\ - \ - `ayx_plugin_cli sdk-workspace-init`\ - \ - The command asks you to provide information about your workspace - through a series of prompts.\ -   -5. Once you have stepped through the above command, run this command to - create a custom tool or plugin:\ - \ - `ayx_plugin_cli create-ayx-plugin`\ - \ - The command asks you to provide information about your tool or - plugin through a series of prompts. Note that this operation can - take a minute to complete. - -Once you have stepped through the above command, you can go to the -location of your workspace and view the files that were created for the -new plugin. - -For more information about the CLI, please visit the [reference -documents](../references/ayx-plugin-cli.md). - -### UI SDK - -The UI SDK consists of 2 pieces. - -- The 1st piece is a React-based [component - library](https://alteryx.github.io/alteryx-ui/) - that enables you to build the interface for your tool or plugin. -- The 2nd piece is a [communication - bridge](https://alteryx.github.io/react-comms/) - that lets you interact with Alteryx Designer and persists the values - that you want to save between runs of a workflow, clicking on and - off a tool. These are also the values that are available to the - engine (back end) of your tool. - -For the real-time Dev Harness that assists in tool UI development, refer to [Dev Harness.](https://github.com/alteryx/dev-harness) - -Follow these steps to get started with the UI SDK: - -1. To start on the user interface of your project, navigate to the - folder that was created for your workspace in the last step of the - CLI section above. In this workspace folder, there is a UI directory - for the workspace. There is a folder inside of this directory with - the same name as the plugin you created. -2. Navigate to [\[workspace directory\]\\ui\\\[plugin - name\]\\src\\src]{.path} for the tool you are working on. -3. Open the index.tsx file. This is the primary - [React](https://reactjs.org/) - file for the tool UI. -4. Make a change to the file. For example, edit the text of a tag, or - add a [new - component](https://alteryx.github.io/alteryx-ui/) - or HTML element to the page. -5. Save the file. -6. For a quick preview of your tool in a browser, run this command:\ - \ - `npm run start` -7. To view your tool in Alteryx Designer, run this command from the - root workspace directory. This command builds and installs your - plugin into Designer.\ - \ - `ayx_plugin_cli designer-install` - -Open Alteryx Designer, search for your tool, place it on the canvas, and -view the changes. - -For more information about the UI SDK, please visit the [reference -documents](https://alteryx.github.io/alteryx-ui/). - - -### Python SDK - - -The Python SDK defines the way that you should create the engine/back -end/runtime of your tool. The back end also receives the configuration -values that were created by the front end of the tool in the UI SDK -section. - -Follow these steps to get started with the Python SDK: - -1. To start on the engine or runtime of your project, navigate to the - folder that was created for your workspace in the last step of the - CLI section above. In this workspace folder, there is a back-end - directory for the workspace. -2. Navigate to [\[workspace directory\]\\backend\\ayx_plugins\\\[plugin - name\].py]{.path} for the tool you are editing. -3. Make changes to the file. -4. Save the file. -5. Run this command from the root workspace directory. This builds and - installs your plugin into Alteryx Designer.\ - \ - `ayx_plugin_cli designer-install` - -Open Alteryx Designer, search for your tool, place it on the canvas, and -view the changes. - -For more information about the Python SDK, please go to the [reference -documents](../references/ayx-python-sdk-v2.md) or access the full [Python -SDK documentation](https://alteryx.github.io/ayx-python-sdk/index.html). -You can also access this documentation locally via this command: - -`ayx_python_sdk docs` - - -### Troubleshooting - -- If you get a workflow error that says 'Can\'t find plugin - \"SdkEnginePlugin.dll\"\', or \"This tool is only supported in the - AMP Engine. Please enable AMP to use this tool.\", [enable the AMP - engine](https://help.alteryx.com/20223/designer/alteryx-amp-engine) - for the workflow. -- If your tool panel does not render or shows a blank screen, [enable - Chrome Developer - Tools](https://help.alteryx.com/developer-help/html-developer-tools). - Now, when you select your tool a Chrome debugger is presented and - you can see any errors for the tool interface. diff --git a/docs/references/assets/failed_to_read_port.png b/docs/references/assets/failed-to-read-port.png similarity index 100% rename from docs/references/assets/failed_to_read_port.png rename to docs/references/assets/failed-to-read-port.png diff --git a/docs/references/assets/tool_is_only_supported_in_amp.png b/docs/references/assets/tool-is-only-supported-in-amp.png similarity index 100% rename from docs/references/assets/tool_is_only_supported_in_amp.png rename to docs/references/assets/tool-is-only-supported-in-amp.png diff --git a/docs/references/assets/update_only.png b/docs/references/assets/update-only.png similarity index 100% rename from docs/references/assets/update_only.png rename to docs/references/assets/update-only.png diff --git a/docs/references/assets/use_amp.png b/docs/references/assets/use-amp.png similarity index 100% rename from docs/references/assets/use_amp.png rename to docs/references/assets/use-amp.png diff --git a/docs/references/assets/workflow_run.png b/docs/references/assets/workflow-run.png similarity index 100% rename from docs/references/assets/workflow_run.png rename to docs/references/assets/workflow-run.png diff --git a/docs/references/ayx-plugin-cli.md b/docs/references/ayx-plugin-cli.md index 8a246b7..d655139 100644 --- a/docs/references/ayx-plugin-cli.md +++ b/docs/references/ayx-plugin-cli.md @@ -33,8 +33,7 @@ these commands: This creates an isolated development environment that minimizes the risk of creating a package that Alteryx Designer and other users won\'t be -able to use. It does this by keeping the dependencies required by -different projects separate. +able to use. It keeps the dependencies that different projects require separate. ### Installation @@ -100,7 +99,7 @@ the current directory, and throw an exception otherwise. ### Parameters Note: If a parameter is not passed in as part of the CLI call, the CLI -will wait for standard input for the ignored parameters, even if they're +waits for standard input for the ignored parameters, even if they're optional. #### \--package-name @@ -175,12 +174,13 @@ these, follow these steps: ### Parameters Note: If a parameter is not passed in as part of the CLI call, the CLI -will wait for standard input for the ignored parameters, even if they're +waits for standard input for the ignored parameters, even if they're optional. #### \--tool-name -This parameter becomes the name of the tool. Spaces are allowed but are cleaned into underscores and Pascal case. For example, for a Python +This parameter becomes the name of the tool. Spaces are allowed but are cleaned into underscores and Pascal +case. For example, for a Python plugin named "A Test Tool", the filename is `a_test_tool.py`, and the `class/ui/config` name is `ATestTool`. diff --git a/docs/references/ayx-python-sdk-v2-example-tools.md b/docs/references/ayx-python-sdk-v2-example-tools.md index 13dfd24..d5ef060 100644 --- a/docs/references/ayx-python-sdk-v2-example-tools.md +++ b/docs/references/ayx-python-sdk-v2-example-tools.md @@ -3,7 +3,7 @@ ### Example Tools These are example tools created using version 2 the [AYX Python -SDK](./ayx-python-sdk-v2.md). When the tools are installed, they display in the SDK +SDK](./platform-sdk.md). When the tools are installed, they display in the SDK Examples tool category in Alteryx Designer. diff --git a/docs/references/ayx-python-sdk-v2.md b/docs/references/ayx-python-sdk-v2.md deleted file mode 100644 index e9f82c4..0000000 --- a/docs/references/ayx-python-sdk-v2.md +++ /dev/null @@ -1,57 +0,0 @@ - -#### Python SDK v2 - -Version 2 of AYX Python SDK is now available. For the best experience, -and to ensure compatibility with the most recent versions of Designer, -please use v2 of AYX Python SDK. - -- To learn more about v2 of the AYX Python SDK, go to [Changes and - Improvements to Python SDK in - v2.0.0](./differences_with_original_sdk_markdown.md). -- If you need to access v1 documentation, you can [download the - content](https://help.alteryx.com/sites/default/files/2022-02/1.0_0.zip). - - -### Overview - -The AYX Python SDK lets you extend the functionality of Alteryx Designer -via custom tools and plugins. This SDK serves as the back-end engine -component. Combine it with the [AYX UI -SDK](https://alteryx.github.io/alteryx-ui/) (which serves as the user interface component) to create your custom -tool or plugin. - -#### Engine Compatibility - -The AYX Python SDK requires that the [AMP -Engine](https://help.alteryx.com/20223/designer/alteryx-amp-engine) is enabled. - -### Requirements and Prerequisites - -To get started with the AYX Python SDK, you need these items installed -on your machine: - -- Microsoft Windows 7 or Later (64-bit) -- Python Version 3.8.5 -- Alteryx Designer Version 2021.4 - -### Installation - -To install the AYX Python SDK, run `pip install ayx-python-sdk`. - -- This command provides the AYX Plugin CLI (top-level CLI) as well as - the AMP Provider classes. -- The AYX Plugin CLI uses the Python SDK CLI to manage the creation - and installation of Python tools. - -As noted above, you can install the package via -[pip](https://pypi.org/). Any updates to -packages will also be available on pip. You do not need to update or -manage this package directly since it is a dependency of the AYX Plugin -CLI. - -### AYX Python SDK Documentation - -You can access the AYX Python SDK documentation at -[https://alteryx.github.io/ayx-python-sdk/index.html](https://alteryx.github.io/ayx-python-sdk/index.html). -Additionally, after you install the AYX Python SDK distribution, you can -run `ayx_python_sdk docs` to access the help documentation locally. diff --git a/docs/references/best_practices.md b/docs/references/best-practices.md similarity index 100% rename from docs/references/best_practices.md rename to docs/references/best-practices.md diff --git a/docs/references/config_xml_markdown.md b/docs/references/config-xml-markdown.md similarity index 100% rename from docs/references/config_xml_markdown.md rename to docs/references/config-xml-markdown.md diff --git a/docs/references/differences_with_original_sdk_markdown.md b/docs/references/differences-with-original-sdk-markdown.md similarity index 95% rename from docs/references/differences_with_original_sdk_markdown.md rename to docs/references/differences-with-original-sdk-markdown.md index f944f68..5de2383 100644 --- a/docs/references/differences_with_original_sdk_markdown.md +++ b/docs/references/differences-with-original-sdk-markdown.md @@ -21,7 +21,7 @@ Getting Started Getting started in the old SDK typically means looking at an example plugin, copying the code and file structure, and then modifying it to suit your own needs. The new SDK provides a command-line interface (CLI) -that takes care of all of this project setup. Go to the [documentation](../howto/platform-sdk-quickstart-guide.md) for more information. +that takes care of all of this project setup. Go to the [documentation](../howto/getting_started_markdown.md) for more information. Development ----------- @@ -61,5 +61,5 @@ the YXI file format. You can find the instructions for packaging a YXI in the original SDK at [Package a Tool](https://help.alteryx.com/current/developer-help/package-tool). This packaging process was significantly simplified by the new SDK CLI, described in the [Getting -Started](../howto/platform-sdk-quickstart-guide.md) +Started](../howto/getting_started_markdown.md) guide. \ No newline at end of file diff --git a/docs/references/example_tools_markdown.md b/docs/references/example-tools-markdown.md similarity index 100% rename from docs/references/example_tools_markdown.md rename to docs/references/example-tools-markdown.md diff --git a/docs/references/faq.md b/docs/references/faq.md index 51c3b36..5f52c89 100644 --- a/docs/references/faq.md +++ b/docs/references/faq.md @@ -15,11 +15,11 @@ For example, one way to do this is in the Windows Environment dialog. Windows 10 If you encounter this error (as shown below) _"This tool is only supported in the AMP Engine. Please enable AMP to use this tool."_: -![Error (use AMP)](assets/tool_is_only_supported_in_amp.png) +![Error (use AMP)](assets/tool-is-only-supported-in-amp.png) Check that the AMP engine is enabled. In Designer's Workflow Configuration window, select the Runtime tab and ensure the Use AMP Engine check box is checked. -![Toggle AMP](assets/use_amp.png) +![Toggle AMP](assets/use-amp.png) If you still encounter the error with the correct configuration, make sure the plugin was produced with version 2+ of the SDK. @@ -34,7 +34,7 @@ ayx_python_sdk==2.1.2 When you encounter a "…Failed to read port assignment…" (below) error message, the cause is almost always a mismatch of versions. That is, you use a V1 plugin in Designer version 2021.4+ that requires a V2 plugin. -![Use Port](assets/failed_to_read_port.png) +![Use Port](assets/failed-to-read-port.png) Another cause might be incorrect plugin code. You can diagnose the issue [here](#can-i-run-plugins-outside-of-designer). @@ -69,7 +69,7 @@ We no longer require the use of Pandas and DataFrames for record IO. If your too ## _"Can I use Python’s multiprocessing and/or threads?"_ -Yes, but only if you really need to. Before you do, please read our [Extensibility Best Practices](./best_practices.md). +Yes, but only if you really need to. Before you do, please read our [Extensibility Best Practices](./best-practices.md). ## _"Can I run Plugins outside of Designer?"_ @@ -176,7 +176,7 @@ The requirements for each package are: The original [Python Engine SDK](https://help.alteryx.com/developer-help/python-engine-sdk) is complex, runs in-process, and can be slow. The [AYX -Python SDK](./ayx-python-sdk-v2.md) design solves these issues. It runs +Python SDK](./platform-sdk.md) design solves these issues. It runs out-of-process using gRPC to communicate. It also simplifies the development process of new tools to 4 function calls, abstracting away a lot of the previous SDK function calls. diff --git a/docs/references/platform-sdk.md b/docs/references/platform-sdk.md index 4c625f2..243f748 100644 --- a/docs/references/platform-sdk.md +++ b/docs/references/platform-sdk.md @@ -27,7 +27,7 @@ A custom tool or plugin consists of 2 components: 2. The engine, which processes logic to handle records passed to and from the Alteryx Engine. To create the engine component, use the [AYX Python - SDK](./ayx-python-sdk-v2.md). + SDK](#python-sdk-v2). To help facilitate the creation of a custom tool or plugin, you can leverage the [AYX Plugin @@ -56,6 +56,63 @@ respective help page below. ### SDK Quickstart Guide -Visit the [Platform SDK Quickstart -Guide](../howto/platform-sdk-quickstart-guide.md) to learn how to use the latest developer tools to -create a custom plugin or tool for use in Alteryx. \ No newline at end of file +Visit the [Getting Started Guide](../howto/getting_started_markdown.md) to learn how to use the latest developer tools to +create a custom plugin or tool for use in Alteryx. + + +### Python SDK v2 + +Version 2 of AYX Python SDK is now available. For the best experience, +and to ensure compatibility with the most recent versions of Designer, +please use v2 of AYX Python SDK. + +- To learn more about v2 of the AYX Python SDK, go to [Changes and + Improvements to Python SDK in + v2.0.0](./differences-with-original-sdk-markdown.md). +- If you need to access v1 documentation, you can [download the + content](https://help.alteryx.com/sites/default/files/2022-02/1.0_0.zip). + + +### Overview + +The AYX Python SDK lets you extend the functionality of Alteryx Designer +via custom tools and plugins. This SDK serves as the back-end engine +component. Combine it with the [AYX UI +SDK](https://alteryx.github.io/alteryx-ui/) (which serves as the user interface component) to create your custom +tool or plugin. + +#### Engine Compatibility + +The AYX Python SDK requires that the [AMP +Engine](https://help.alteryx.com/20223/designer/alteryx-amp-engine) is enabled. + +### Requirements and Prerequisites + +To get started with the AYX Python SDK, you need these items installed +on your machine: + +- Microsoft Windows 7 or Later (64-bit) +- Python Version 3.8.5 +- Alteryx Designer Version 2021.4 + +### Installation + +To install the AYX Python SDK, run `pip install ayx-python-sdk`. + +- This command provides the AYX Plugin CLI (top-level CLI) as well as + the AMP Provider classes. +- The AYX Plugin CLI uses the Python SDK CLI to manage the creation + and installation of Python tools. + +As noted above, you can install the package via +[pip](https://pypi.org/). Any updates to +packages will also be available on pip. You do not need to update or +manage this package directly since it is a dependency of the AYX Plugin +CLI. + +### AYX Python SDK Documentation + +You can access the AYX Python SDK documentation at +[https://alteryx.github.io/ayx-python-sdk/index.html](https://alteryx.github.io/ayx-python-sdk/index.html). +Additionally, after you install the AYX Python SDK distribution, you can +run `ayx_python_sdk docs` to access the help documentation locally. diff --git a/docs/references/plugin_code_markdown.md b/docs/references/plugin-code-markdown.md similarity index 98% rename from docs/references/plugin_code_markdown.md rename to docs/references/plugin-code-markdown.md index 72c097b..9407b09 100644 --- a/docs/references/plugin_code_markdown.md +++ b/docs/references/plugin-code-markdown.md @@ -11,7 +11,7 @@ Designer. These interactions are mediated by the Providers, which provide simplified interfaces for Designer functionality and drive the execution of the Ayx Plugin Tools. For more information on the execution flow, see [Plugin -Lifecycle](../references/plugin_lifecycle_markdown.md). +Lifecycle](../references/plugin-lifecycle-markdown.md). Register the Plugin ------------------- diff --git a/docs/references/plugin_lifecycle_markdown.md b/docs/references/plugin-lifecycle-markdown.md similarity index 96% rename from docs/references/plugin_lifecycle_markdown.md rename to docs/references/plugin-lifecycle-markdown.md index 041f72d..2c8b4c9 100644 --- a/docs/references/plugin_lifecycle_markdown.md +++ b/docs/references/plugin-lifecycle-markdown.md @@ -54,7 +54,7 @@ etc.). Refer to this sequence diagram for a visual representation of this lifecycle: -![Workflow Run Sequence Diagram](assets/workflow_run.png) +![Workflow Run Sequence Diagram](assets/workflow-run.png) Update Only Run --------------- @@ -85,4 +85,4 @@ processing in this method, since a fast update makes users happy. Refer to the sequence diagram for a visual representation of this lifecycle: -![Update Only Sequence Diagram](assets/update_only.png) +![Update Only Sequence Diagram](assets/update-only.png) diff --git a/docs/references/python_embeddable_distribution_markdown.md b/docs/references/python-embeddable-distribution-markdown.md similarity index 100% rename from docs/references/python_embeddable_distribution_markdown.md rename to docs/references/python-embeddable-distribution-markdown.md diff --git a/docs/references/third_party_packages_markdown.md b/docs/references/third-party-packages-markdown.md similarity index 100% rename from docs/references/third_party_packages_markdown.md rename to docs/references/third-party-packages-markdown.md diff --git a/docs/references/virtual_environments_markdown.md b/docs/references/virtual-environments-markdown.md similarity index 100% rename from docs/references/virtual_environments_markdown.md rename to docs/references/virtual-environments-markdown.md