Merge pull request #470 from Avaiga/feature/#465-PipelineConfig-depre…

…cated feature/#465 added deprecation warning for pipeline
Avaiga · Jun 8, 2023 · 65069d6 · 65069d6
2 parents 3df5b7f + cead1ea
commit 65069d6
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 0 deletions.
diff --git a/docs/manuals/core/config/pipeline-config.md b/docs/manuals/core/config/pipeline-config.md
@@ -1,3 +1,7 @@
+!!! warning "Deprecation"
+
+    Note that `PipelineConfig^` has been deprecated in version 2.3 and will be combined with `ScenarioConfig^` in the following major version.
+
 A pipeline configuration is necessary to instantiate a [Pipeline](../concepts/pipeline.md). To create a
 `PipelineConfig^`, you can use the `Config.configure_pipeline()^` method with the following parameters:
 

diff --git a/docs/manuals/core/config/scenario-config.md b/docs/manuals/core/config/scenario-config.md
@@ -16,6 +16,12 @@ A scenario configuration is necessary to instantiate a [Scenario](../concepts/sc
     Note that we cannot use the word "_entity_owner" as a key in the properties as it has been reserved for internal use.
 
 # From pipeline configs
+
+!!! warning "Deprecation"
+
+    Note that `PipelineConfig^` has been deprecated in version 2.3 and will be combined with `ScenarioConfig^` in the following major version.
+    It is recommended to configure ScenarioConfig with `configure_scenario_from_tasks` instead.
+
 Here is a simple example assuming the pipeline configuration `pipeline_cfg` has already been created:
 
 ```python linenums="1"

diff --git a/docs/manuals/core/entities/pipeline-mgt.md b/docs/manuals/core/entities/pipeline-mgt.md
@@ -1,3 +1,7 @@
+!!! warning "Deprecation"
+
+    Note that the `PipelineConfig^` has been deprecated in version 2.3. The `Pipeline^` entity will be strongly impacted in the following major version.
+
 The [Entities' creation](scenario-creation.md) section provides documentation on `Pipeline^` creation. Now
 that we know how to create a new `Pipeline^`, this section focuses on describing the pipeline's attributes
 and utility methods.

diff --git a/docs/manuals/core/entities/scenario-creation.md b/docs/manuals/core/entities/scenario-creation.md
@@ -70,6 +70,11 @@ Three parameters can be given to the scenario creation method :
         ![scenarios](../pic/scenarios.svg)
 
 # Pipeline creation
+
+!!! warning "Deprecation"
+
+    Note that function `taipy.create_pipeline()^` has been deprecated in version 2.3.
+
 Pipelines can be created separately from scenarios using `taipy.create_pipeline()^` function.
 
 This function creates and returns a new pipeline from the pipeline configuration provided as a parameter. The

diff --git a/docs/relnotes.md b/docs/relnotes.md
@@ -54,6 +54,14 @@ Not published yet.
 - The `read_fct_params` and `write_fct_params` of a generic data node are renamed to `read_fct_args` and `write_fct_args`, and both must be populated with a List value to avoid the problem of passing Tuple of one string.<br/>
 - The `validity_period` attribute of a data node is now exposed at configuration level to set the up-to-date duration of a data node.<br/>
 
+### Deprecations
+
+<h6 style="font-size: 1.2em"><strong><code>taipy-core</code></strong></h6>
+2.3.0
+
+- `PipelineConfig^` has been deprecated and will be combined with `ScenarioConfig^` in future update.
+- `taipy.create_pipeline()^` has been deprecated.
+
 ## Community edition: 2.2
 
 Published on 2023-04.