Skip to content

Commit

Permalink
Merge pull request #799 from Avaiga/fix/#745-wrong-link-to-download-c…
Browse files Browse the repository at this point in the history
…onfig-file

Wrong link to download my_config.py file
  • Loading branch information
trgiangdo authored Jan 23, 2024
2 parents 3fa85e0 + 24b9ddd commit a9556b0
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 19 deletions.
22 changes: 9 additions & 13 deletions docs/manuals/core/entities/data-node-mgt.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Data nodes get created when scenarios are created. Please refer to the
[Entities' creation](scenario-creation.md) section for more details.

In this section, it is assumed that <a href="./code_example/my_config.py" download>`my_config.py`</a>
In this section, it is assumed that <a href="../code_example/my_config.py" download>`my_config.py`</a>
module contains a Taipy configuration already implemented.

# Data node attributes
Expand Down Expand Up @@ -385,8 +385,8 @@ To write with custom column names, use the `CSVDataNode.write_with_column_names(
When reading from an Excel data node, Taipy returns the data of the Excel file based on the _exposed_type_ parameter.
Check out [Excel Data Node configuration](../config/data-node-config.md#excel) for more details on _exposed_type_.

For the example in this section, assume that `sales_history_cfg` in [`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py)
is an _Excel_ data node configuration with `default_path="path/sales.xlsx"`.
For the example in this section, assume that *sales_history_cfg* is an *Excel* data node
configuration with `default_path="path/sales.xlsx"`.

Assume that the content of the `sales.xlsx` file is the following.

Expand Down Expand Up @@ -542,8 +542,7 @@ To write with custom column names, use the `ExcelDataNode.write_with_column_name
When reading from a SQL Table data node, Taipy returns the data of the SQL Table file based on the _exposed_type_ parameter.
Check out [SQL Table Data Node configuration](../config/data-node-config.md#sql-table) for more details on _exposed_type_.

For the example in this section, assume that `sales_history_cfg` in [`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py)
is a _SQL Table_ data node configuration with `table_name="sales"`.
For the example in this section, assume that *sales_history_cfg* is a *SQL Table* data node configuration with `table_name="sales"`.

Assume that the content of the `"sales"` table is the following.

Expand Down Expand Up @@ -689,8 +688,7 @@ node:
A SQL data node is designed to give the user more flexibility on how to read and write to SQL table
(or multiple SQL tables).

Let's consider the `orders_cfg` in
[`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py)
Let's consider the *orders_cfg* in <a href="../code_example/my_config.py" download>`my_config.py`</a>
which configures a SQL data node.

When reading from a SQL data node, Taipy executes the read query and returns the data of the SQL
Expand Down Expand Up @@ -803,9 +801,8 @@ also encode and decode:
- A [`datetime.datetime`](https://docs.python.org/3/library/datetime.html#datetime-objects) object.
- A [dataclass](https://docs.python.org/3/library/dataclasses.html) object.

For the example in this section, assume that `sales_history_cfg` in
[`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py)
is a _JSON_ data node configuration with `default_path="path/sales.json"`.
For the example in this section, assume that *sales_history_cfg* is a *JSON* data node configuration
with `default_path="path/sales.json"`.

!!! example "Read and write from a JSON data node using default _encoder_ and _decoder_"

Expand Down Expand Up @@ -1095,9 +1092,8 @@ MongoDB, including but not limited to:
- Object (embedded document object).
- Arrays − arrays or list or multiple values.

For the example in this section, assume that `sales_history_cfg` in
[`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py)
is a _Mongo collection_ data node configuration.
For the example in this section, assume that *sales_history_cfg* is a *Mongo collection* data node
configuration.

Check out [MongoDB supported data types](https://www.mongodb.com/docs/manual/reference/bson-types/) for more details.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ can run different Taipy services, please refer to the

After running the Core service, all configuration are blocked from update.

In this section, it is assumed that <a href="./code_example/my_config.py" download>`my_config.py`</a>
In this section, it is assumed that <a href="../code_example/my_config.py" download>`my_config.py`</a>
module contains a Taipy configuration already implemented.

To execute a scenario, you need to call the `taipy.submit()^` function. It returns a `Submission^` object containing
Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/core/entities/scenario-creation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
In this section, it is assumed that <a href="./code_example/my_config.py" download>`my_config.py`</a>
In this section, it is assumed that <a href="../code_example/my_config.py" download>`my_config.py`</a>
module contains a Taipy configuration already implemented.

# Scenario creation
Expand Down Expand Up @@ -39,7 +39,7 @@ Three parameters can be given to the scenario creation method :
!!! example

=== "Scenario creation with parameters"
Using the [`my_config.py`](./code_example/my_config.py) module, here is an example of how to create a scenario.
Using the <a href="../code_example/my_config.py" download>`my_config.py`</a> module, here is an example of how to create a scenario.

```python linenums="1"
import taipy as tp
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/core/entities/scenario-cycle-mgt.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The [previous section](scenario-creation.md) provided documentation on `Scenario^` creation. Now that we know how to
create a new `Scenario^`, this section will describe the scenario's attributes and the various utility methods.

In this section, it is assumed that the <a href="./code_example/my_config.py" download>`my_config.py`</a>
In this section, it is assumed that the <a href="../code_example/my_config.py" download>`my_config.py`</a>
module contains a Taipy configuration already implemented.

# Scenario attributes
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/core/entities/sequence-mgt.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ The [Entities' creation](scenario-creation.md) section provides documentation on
that we know how to create a new `Sequence^`, this section focuses on describing the sequence's attributes
and utility methods.

In this section, it is assumed that the <a href="./code_example/my_config.py" download>`my_config.py`</a>
In this section, it is assumed that the <a href="../code_example/my_config.py" download>`my_config.py`</a>
module contains an already implemented configuration.

# Sequence attributes
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/core/entities/task-mgt.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Tasks get created when scenarios are created. Please refer to the
[Entities' creation](scenario-creation.md) section for more details.

In this section, it is assumed that <a href="./code_example/my_config.py" download>`my_config.py`</a>
In this section, it is assumed that <a href="../code_example/my_config.py" download>`my_config.py`</a>
module contains a Taipy configuration already implemented.

# Task attributes
Expand Down

0 comments on commit a9556b0

Please sign in to comment.