Remove chapter numbers from paths in tutorial files

finos · Nov 10, 2024 · e32ba73 · e32ba73
1 parent 3ef3648
commit e32ba73
Show file tree

Hide file tree

Showing 11 changed files with 13 additions and 13 deletions.
diff --git 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/...dev/tutorial/chapter_5_error_handling.rst → doc/app_dev/tutorial/error_handling.rst b/...dev/tutorial/chapter_5_error_handling.rst → 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/...pp_dev/tutorial/chapter_1_hello_world.rst → doc/app_dev/tutorial/hello_world.rst b/...pp_dev/tutorial/chapter_1_hello_world.rst → 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 <https://github.com/finos/tracdap>`_
+`TRAC GitHub Repository <https://github.com/finos/tracdap>`_
 and follow the instructions in the main
 `README <https://github.com/finos/tracdap#readme>`_
 file.

diff --git 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/..._dev/tutorial/chapter_2_metadata_mojo.rst → doc/app_dev/tutorial/metadata_mojo.rst b/..._dev/tutorial/chapter_2_metadata_mojo.rst → doc/app_dev/tutorial/metadata_mojo.rst
diff --git a/doc/app_dev/tutorial/chapter_4_streaming.rst → doc/app_dev/tutorial/streaming.rst b/doc/app_dev/tutorial/chapter_4_streaming.rst → doc/app_dev/tutorial/streaming.rst
diff --git a/...app_dev/tutorial/chapter_3_using_data.rst → doc/app_dev/tutorial/using_data.rst b/...app_dev/tutorial/chapter_3_using_data.rst → doc/app_dev/tutorial/using_data.rst
diff --git a/...elling/tutorial/chapter_1_hello_world.rst → doc/modelling/tutorial/hello_world.rst b/...elling/tutorial/chapter_1_hello_world.rst → 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 <modelling/tutorial/chapter_1_hello_world:Installing the runtime>`
+:ref:`skip this section <modelling/tutorial/hello_world:Installing the runtime>`
 
 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
@@ -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/...tutorial/chapter_3_inputs_and_outputs.rst → ...modelling/tutorial/inputs_and_outputs.rst b/...tutorial/chapter_3_inputs_and_outputs.rst → ...modelling/tutorial/inputs_and_outputs.rst
diff --git a/...delling/tutorial/chapter_2_using_data.rst → doc/modelling/tutorial/using_data.rst b/...delling/tutorial/chapter_2_using_data.rst → doc/modelling/tutorial/using_data.rst