From e32ba732ccf9ac8b6bee46e655fb59c3c1314dca Mon Sep 17 00:00:00 2001 From: Martin Traverse Date: Sun, 10 Nov 2024 13:23:32 +0000 Subject: [PATCH] Remove chapter numbers from paths in tutorial files --- README.md | 2 +- ...chapter_5_error_handling.rst => error_handling.rst} | 4 ++-- .../{chapter_1_hello_world.rst => hello_world.rst} | 2 +- doc/app_dev/tutorial/index.rst | 10 +++++----- .../{chapter_2_metadata_mojo.rst => metadata_mojo.rst} | 0 .../{chapter_4_streaming.rst => streaming.rst} | 0 .../{chapter_3_using_data.rst => using_data.rst} | 0 .../{chapter_1_hello_world.rst => hello_world.rst} | 2 +- doc/modelling/tutorial/index.rst | 6 +++--- ...3_inputs_and_outputs.rst => inputs_and_outputs.rst} | 0 .../{chapter_2_using_data.rst => using_data.rst} | 0 11 files changed, 13 insertions(+), 13 deletions(-) rename doc/app_dev/tutorial/{chapter_5_error_handling.rst => error_handling.rst} (96%) rename doc/app_dev/tutorial/{chapter_1_hello_world.rst => hello_world.rst} (99%) rename doc/app_dev/tutorial/{chapter_2_metadata_mojo.rst => metadata_mojo.rst} (100%) rename doc/app_dev/tutorial/{chapter_4_streaming.rst => streaming.rst} (100%) rename doc/app_dev/tutorial/{chapter_3_using_data.rst => using_data.rst} (100%) rename doc/modelling/tutorial/{chapter_1_hello_world.rst => hello_world.rst} (99%) rename doc/modelling/tutorial/{chapter_3_inputs_and_outputs.rst => inputs_and_outputs.rst} (100%) rename doc/modelling/tutorial/{chapter_2_using_data.rst => using_data.rst} (100%) diff --git a/README.md b/README.md index e128226ef..aaea19590 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ With TRAC D.A.P. you can build and run production-ready models right on your des All you need is an IDE, Python and the tracdap-runtime Python package. TRAC D.A.P. requires Python 3.8 or later. -The [modelling tutorial](https://tracdap.finos.org/en/stable/modelling/tutorial/chapter_1_hello_world.html) +The [modelling tutorial](https://tracdap.finos.org/en/stable/modelling/tutorial/hello_world.html) shows you how to get set up and write your first models. You can write models locally using an IDE or notebook, once the model is working t can be loaded to the platform without modification. TRAC D.A.P. will validate the model and ensure it behaves the same on-platform as it does locally. diff --git a/doc/app_dev/tutorial/chapter_5_error_handling.rst b/doc/app_dev/tutorial/error_handling.rst similarity index 96% rename from doc/app_dev/tutorial/chapter_5_error_handling.rst rename to doc/app_dev/tutorial/error_handling.rst index 97fbc21cf..289f2285e 100644 --- a/doc/app_dev/tutorial/chapter_5_error_handling.rst +++ b/doc/app_dev/tutorial/error_handling.rst @@ -75,7 +75,7 @@ Errors in streaming calls ------------------------- .. seealso:: - See :doc:`./chapter_4_streaming` for more details on the streaming data API. + See :doc:`./streaming` for more details on the streaming data API. **Errors in upload streams** @@ -126,7 +126,7 @@ to no-op functions to avoid unhandled or duplicate events. **Using promises for streaming operations** -In :doc:`./chapter_4_streaming`, the streaming operations are wrapped up into promises and errors are +In :doc:`./streaming`, the streaming operations are wrapped up into promises and errors are passed directly to the promise *resolve()* method. Once the operation is wrapped up into a promise, errors can be processed using a regular ``.catch()``. diff --git a/doc/app_dev/tutorial/chapter_1_hello_world.rst b/doc/app_dev/tutorial/hello_world.rst similarity index 99% rename from doc/app_dev/tutorial/chapter_1_hello_world.rst rename to doc/app_dev/tutorial/hello_world.rst index c2a046fd9..59e530c11 100644 --- a/doc/app_dev/tutorial/chapter_1_hello_world.rst +++ b/doc/app_dev/tutorial/hello_world.rst @@ -25,7 +25,7 @@ Setting up a dev environment ---------------------------- The easiest way to get a local development instance of TRAC is to clone the -`TRAC d.a.p. GitHub Repository `_ +`TRAC GitHub Repository `_ and follow the instructions in the main `README `_ file. diff --git a/doc/app_dev/tutorial/index.rst b/doc/app_dev/tutorial/index.rst index 00b947ec4..9c93566b1 100644 --- a/doc/app_dev/tutorial/index.rst +++ b/doc/app_dev/tutorial/index.rst @@ -5,8 +5,8 @@ App Dev Tutorial .. toctree:: - ./chapter_1_hello_world - ./chapter_2_metadata_mojo - ./chapter_3_using_data - ./chapter_4_streaming - ./chapter_5_error_handling + ./hello_world + ./metadata_mojo + ./using_data + ./streaming + ./error_handling diff --git a/doc/app_dev/tutorial/chapter_2_metadata_mojo.rst b/doc/app_dev/tutorial/metadata_mojo.rst similarity index 100% rename from doc/app_dev/tutorial/chapter_2_metadata_mojo.rst rename to doc/app_dev/tutorial/metadata_mojo.rst diff --git a/doc/app_dev/tutorial/chapter_4_streaming.rst b/doc/app_dev/tutorial/streaming.rst similarity index 100% rename from doc/app_dev/tutorial/chapter_4_streaming.rst rename to doc/app_dev/tutorial/streaming.rst diff --git a/doc/app_dev/tutorial/chapter_3_using_data.rst b/doc/app_dev/tutorial/using_data.rst similarity index 100% rename from doc/app_dev/tutorial/chapter_3_using_data.rst rename to doc/app_dev/tutorial/using_data.rst diff --git a/doc/modelling/tutorial/chapter_1_hello_world.rst b/doc/modelling/tutorial/hello_world.rst similarity index 99% rename from doc/modelling/tutorial/chapter_1_hello_world.rst rename to doc/modelling/tutorial/hello_world.rst index 6d8e3913d..62a4e225f 100644 --- a/doc/modelling/tutorial/chapter_1_hello_world.rst +++ b/doc/modelling/tutorial/hello_world.rst @@ -21,7 +21,7 @@ Setting up a new project If you are starting a project from scratch, it's a good idea to follow the standard Python conventions for package naming and folder layout. If you are working on an existing project or are already familiar with the Python conventions, then you can -:ref:`skip this section ` +:ref:`skip this section ` For this example we will create a project folder called example-project. Typically this will be a Git repository. You will also want to create a Python virtual environment diff --git a/doc/modelling/tutorial/index.rst b/doc/modelling/tutorial/index.rst index aa7f46416..26ade72a6 100644 --- a/doc/modelling/tutorial/index.rst +++ b/doc/modelling/tutorial/index.rst @@ -5,6 +5,6 @@ Modelling Tutorial .. toctree:: - ./chapter_1_hello_world - ./chapter_2_using_data - ./chapter_3_inputs_and_outputs + ./hello_world + ./using_data + ./inputs_and_outputs diff --git a/doc/modelling/tutorial/chapter_3_inputs_and_outputs.rst b/doc/modelling/tutorial/inputs_and_outputs.rst similarity index 100% rename from doc/modelling/tutorial/chapter_3_inputs_and_outputs.rst rename to doc/modelling/tutorial/inputs_and_outputs.rst diff --git a/doc/modelling/tutorial/chapter_2_using_data.rst b/doc/modelling/tutorial/using_data.rst similarity index 100% rename from doc/modelling/tutorial/chapter_2_using_data.rst rename to doc/modelling/tutorial/using_data.rst