fix: update aterises and CONTRIBUTING.md link

taipy/config/INSTALLATION.md

@@ -12,10 +12,10 @@ You can install the development version of *taipy-config* with `pip` and `git` d
 pip install git+https://git@github.com/Avaiga/taipy
 ```
 
-This command installs the development version of _taipy_ package in the Python environment with all
-its dependencies, including the _taipy-config_ package.
+This command installs the development version of *taipy* package in the Python environment with all
+its dependencies, including the *taipy-config* package.
 
-If you need the source code for _taipy-config_ on your system so you can see how things are done or
+If you need the source code for *taipy-config* on your system so you can see how things are done or
 maybe participate in the improvement of the packages, you can clone the GitHub repository:
 
 ```bash

taipy/config/README.md

@@ -1,4 +1,4 @@
-# Taipy config
+# Taipy Config
 
 ## License
 Copyright 2021-2024 Avaiga Private Limited
@@ -14,33 +14,33 @@ specific language governing permissions and limitations under the License.
 ## Usage
 - [License](#license)
 - [Usage](#usage)
-- [Taipy config](#what-is-taipy-config)
+- [Taipy Config](#what-is-taipy-config)
 - [Installation](#installation)
 - [Contributing](#contributing)
 - [Code of conduct](#code-of-conduct)
 - [Directory Structure](#directory-structure)
 
-## What is Taipy config
+## What is Taipy Config
 
 Taipy is a Python library for creating Business Applications. More information on our
-[website](https://www.taipy.io). Taipy is split into multiple repositories including _taipy-config_ to let users
+[website](https://www.taipy.io). Taipy is split into multiple repositories including *taipy-config* to let users
 install the minimum they need.
 
-Taipy config is a package designed to help users configure their Taipy application.
+Taipy Config is a package designed to help users configure their Taipy application.
 
 More in-depth documentation of taipy can be found [here](https://docs.taipy.io).
 
 ## Installation
 
-Want to install _Taipy config_? Check out our [`INSTALLATION.md`](INSTALLATION.md) file.
+Want to install *Taipy Config*? Check out our [`INSTALLATION.md`](INSTALLATION.md) file.
 
 ## Contributing
 
-Want to help build _Taipy config_? Check out our [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
+Want to help build *Taipy Config*? Check out our [`CONTRIBUTING.md`](../../CONTRIBUTING.md) file.
 
 ## Code of conduct
 
-Want to be part of the _Taipy config_ community? Check out our [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) file.
+Want to be part of the *Taipy Config* community? Check out our [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) file.
 
 ## Directory Structure
 
@@ -54,11 +54,11 @@ Want to be part of the _Taipy config_ community? Check out our [`CODE_OF_CONDUCT
     - `global_app/`: `GlobalAppConfig` implementation.
     - `stubs/`: Helper functions to create the `config.pyi` file.
     - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of *taipy-config*.
-    - `CONTRIBUTING.md`: Instructions to contribute to _taipy-config_.
-    - `INSTALLATION.md`: Instructions to install _taipy-config_.
+    - `CONTRIBUTING.md`: Instructions to contribute to *taipy-config*.
+    - `INSTALLATION.md`: Instructions to install *taipy-config*.
     - `LICENSE`: The Apache 2.0 License.
     - `README.md`: Current file.
-    - `setup.py`: The setup script managing building, distributing, and installing _taipy-config_.
+    - `setup.py`: The setup script managing building, distributing, and installing *taipy-config*.
   - `logger/`: Taipy logger implementation.
 - `tests/`:
-  - `config/`: Tests for the _taipy-config_ package.
+  - `config/`: Tests for the *taipy-config* package.

taipy/core/INSTALLATION.md

@@ -1,21 +1,21 @@
 # Installation
 
-The latest stable version of _taipy-core_ is available through _pip_:
+The latest stable version of *taipy-core* is available through *pip*:
 ```bash
 pip install taipy-core
 ```
 
 ## Development version
 
-You can install the development version of _taipy-core_ with _pip_ and _git_ via the taipy repository:
+You can install the development version of *taipy-core* with *pip* and *git* via the taipy repository:
 ```bash
 pip install git+https://git@github.com/Avaiga/taipy
 ```
 
-This command installs the development version of _taipy_ package in the Python environment with all
-its dependencies, including the _taipy-core_ package.
+This command installs the development version of *taipy* package in the Python environment with all
+its dependencies, including the *taipy-core* package.
 
-If you need the source code for _taipy-core_ on your system so you can see how things are done or
+If you need the source code for *taipy-core* on your system so you can see how things are done or
 maybe participate in the improvement of the packages, you can clone the GitHub repository:
 
 ```bash
@@ -36,7 +36,7 @@ pip install pipenv
 pipenv install --dev
 ```
 
-Then you can run _taipy-core_ tests with the following command:
+Then you can run *taipy-core* tests with the following command:
 
 ```bash
 pipenv run pytest tests/core

taipy/core/README.md

@@ -28,7 +28,7 @@ and limitations under the License.
 
 Taipy is a Python library for creating Business Applications. More information on our
 [website](https://www.taipy.io). Taipy is split into multiple repositories including
-_taipy-core_ to let users install the minimum they need.
+*taipy-core* to let users install the minimum they need.
 
 Taipy Core mostly includes business-oriented
 features. It helps users create and manage business applications and improve analyses
@@ -38,15 +38,15 @@ A more in depth documentation of taipy can be found [here](https://docs.taipy.io
 
 ## Installation
 
-Want to install _Taipy Core_? Check out our [`INSTALLATION.md`](INSTALLATION.md) file.
+Want to install *Taipy Core*? Check out our [`INSTALLATION.md`](INSTALLATION.md) file.
 
 ## Contributing
 
-Want to help build _Taipy Core_? Check out our [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
+Want to help build *Taipy Core*? Check out our [`CONTRIBUTING.md`](../../CONTRIBUTING.md) file.
 
 ## Code of conduct
 
-Want to be part of the _Taipy Core_ community? Check out our
+Want to be part of the *Taipy Core* community? Check out our
 [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) file.
 
 ## Directory Structure
@@ -62,19 +62,19 @@ Want to be part of the _Taipy Core_ community? Check out our
     - `config/`: Configuration definition, management and implementation.
     - `cycle/`: Work cycle definition, management and implementation.
     - `data/`: Data Node definition, management and implementation.
-    - `exceptions/`: _taipy-core_ exceptions.
+    - `exceptions/`: *taipy-core* exceptions.
     - `job/`: Job definition, management and implementation.
     - `notification/`: Notification management system implementation.
     - `scenario/`: Scenario definition, management and implementation.
     - `sequence/`: Sequence definition, management and implementation.
     - `submission/`: Submission definition, management and implementation.
     - `task/`: Task definition, management and implementation.
-    - `taipy.py`: Main entrypoint for _taipy-core_ runtime features.
-    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-core_.
-    - `CONTRIBUTING.md`: Instructions to contribute to _taipy-core_.
-    - `INSTALLATION.md`: Instructions to install _taipy-core_.
+    - `taipy.py`: Main entrypoint for *taipy-core* runtime features.
+    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of *taipy-core*.
+    - `CONTRIBUTING.md`: Instructions to contribute to *taipy-core*.
+    - `INSTALLATION.md`: Instructions to install *taipy-core*.
     - `LICENSE`: The Apache 2.0 License.
     - `README.md`: Current file.
-    - `setup.py`: The setup script managing building, distributing, and installing _taipy-core_.
+    - `setup.py`: The setup script managing building, distributing, and installing *taipy-core*.
 - `tests/`:
   - `core/`: Unit tests following the `taipy/core/` structure.

taipy/gui/INSTALLATION.md

@@ -12,8 +12,6 @@ you plan to use it:
 - [Debugging the JavaScript bundle](#debugging-the-javascript-bundle)
 - [Running the tests](#running-the-tests)
 
-
-
 Taipy GUI needs your system to have **Python 3.8** or above installed.
 
 ## Installing the latest release
@@ -129,7 +127,7 @@ pip install pipenv
 pipenv install --dev
 ```
 
-Then you can run _taipy-gui_ tests with the following command:
+Then you can run *taipy-gui* tests with the following command:
 
 ```bash
 pipenv run pytest tests/gui

taipy/gui/README.md

@@ -36,7 +36,7 @@ Want to install and try *Taipy GUI*? Check out our [`INSTALLATION.md`](INSTALLAT
 
 ## Contributing
 
-Want to help build *Taipy GUI*? Check out our [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
+Want to help build *Taipy GUI*? Check out our [`CONTRIBUTING.md`](../../CONTRIBUTING.md) file.
 
 ## Code of conduct
 

taipy/rest/INSTALLATION.md

@@ -1,21 +1,21 @@
 # Installation
 
-The latest stable version of _taipy-rest_ is available through _pip_:
+The latest stable version of *taipy-rest* is available through *pip*:
 ```bash
 pip install taipy-rest
 ```
 
 ## Development version
 
-You can install the development version of _taipy-rest_ with _pip_ and _git_ via the taipy repository:
+You can install the development version of *taipy-rest* with *pip* and *git* via the taipy repository:
 ```bash
 pip install git+https://git@github.com/Avaiga/taipy
 ```
 
-This command installs the development version of _taipy_ package in the Python environment with all
-its dependencies, including the _taipy-rest_ package.
+This command installs the development version of *taipy* package in the Python environment with all
+its dependencies, including the *taipy-rest* package.
 
-If you need the source code for _taipy-rest_ on your system so you can see how things are done or
+If you need the source code for *taipy-rest* on your system so you can see how things are done or
 maybe participate in the improvement of the packages, you can clone the GitHub repository:
 
 ```bash
@@ -27,7 +27,7 @@ source code is in the 'taipy/rest' directory.
 
 # Configuration
 
-Before running, we need to define some variables. Taipy rest APIs depend on pre-configuration of taipy config objects,
+Before running, we need to define some variables. Taipy REST APIs depend on pre-configuration of taipy config objects,
 i.e, is mandatory to define all configuration of DataNodes, Tasks, Sequences, etc. The file containing this
 configuration needs to be passed to the application at runtime. The following variable needs to be defined:
  - TAIPY_SETUP_FILE: the path to the file containing all of taipy object configuration
@@ -69,7 +69,7 @@ pip install gunicorn
 
 gunicorn myapi.wsgi:app
 ```
-And that's it ! Gunicorn is running on port 8000
+And that's it! Gunicorn is running on port 8000.
 
 If you chose gunicorn as your wsgi server, the proper commands should be in your docker-compose file.
 
@@ -82,7 +82,7 @@ pip install uwsgi
 uwsgi --http 127.0.0.1:5000 --module myapi.wsgi:app
 ```
 
-And that's it ! Uwsgi is running on port 5000
+And that's it! Uwsgi is running on port 5000.
 
 If you chose uwsgi as your wsgi server, the proper commands should be in your docker-compose file.
 
@@ -111,7 +111,7 @@ Then release the image:
 heroku container:release web
 ```
 
-You can now access **taipy rest** on the URL that was returned on the `heroku create` command.
+You can now access *taipy-rest* on the URL that was returned on the `heroku create` command.
 
 # Documentation
 

taipy/rest/README.md

@@ -1,4 +1,4 @@
-# Taipy-REST
+# Taipy REST
 
 ## License
 Copyright 2021-2024 Avaiga Private Limited
@@ -27,16 +27,16 @@ and limitations under the License.
 
 Taipy is a Python library for creating Business Applications. More information on our
 [website](https://www.taipy.io). Taipy is split into multiple repositories including
-_taipy-core_ and _taipy-rest_ to let users install the minimum they need.
+*taipy-core* and *taipy-rest* to let users install the minimum they need.
 
 Taipy Core mostly includes business-oriented
 features. It helps users create and manage business applications and improve analyses
 capability through time, conditions and hypothesis.
 
 Taipy REST is a set of APIs built on top of the
-_taipy-core_ library developed by Avaiga. This project is meant to be used as a complement
-for **taipy** and its goal is to enable automation through rest APIs of processes built
-on taipy.
+*taipy-core* library developed by Avaiga. This project is meant to be used as a complement
+for Taipy and its goal is to enable automation through rest APIs of processes built
+on Taipy.
 
 The project comes with rest APIs that provide interaction with all of taipy modules:
  - DataNodes
@@ -50,15 +50,15 @@ A more in depth documentation of taipy can be found [here](https://docs.taipy.io
 
 ## Installation
 
-Want to install and try _Taipy REST_? Check out our [`INSTALLATION.md`](INSTALLATION.md) file.
+Want to install and try *Taipy REST*? Check out our [`INSTALLATION.md`](INSTALLATION.md) file.
 
 ## Contributing
 
-Want to help build _Taipy REST_? Check out our [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
+Want to help build *Taipy REST*? Check out our [`CONTRIBUTING.md`](../../CONTRIBUTING.md) file.
 
 ## Code of conduct
 
-Want to be part of the _Taipy REST_ community? Check out our
+Want to be part of the *Taipy REST* community? Check out our
 [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) file.
 
 ## Directory Structure
@@ -73,12 +73,12 @@ Want to be part of the _Taipy REST_ community? Check out our
       - `templates/`: Swagger and redoc templates for generating the documentation
     - `app.py`: Flask app configuration and creation
     - `extensions.py`: Singletons used on the application factory
-    - `rest.py`: Main python entrypoint for running _taipy-rest_ application.
-    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-rest_.
-    - `CONTRIBUTING.md`: Instructions to contribute to _taipy-rest_.
-    - `INSTALLATION.md`: Instructions to install _taipy-rest_.
+    - `rest.py`: Main python entrypoint for running *taipy-rest* application.
+    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of *taipy-rest*.
+    - `CONTRIBUTING.md`: Instructions to contribute to *taipy-rest*.
+    - `INSTALLATION.md`: Instructions to install *taipy-rest*.
     - `LICENSE`: The Apache 2.0 License.
     - `README.md`: Current file.
-    - `setup.py`: The setup script managing building, distributing, and installing _taipy-rest_.
+    - `setup.py`: The setup script managing building, distributing, and installing *taipy-rest*.
 - `tests/`:
   - `rest/`: Unit tests following the `taipy/rest/` structure.

taipy/templates/README.md

@@ -46,11 +46,11 @@ working directory.
 
 ## Contributing
 
-Want to help build _Taipy_? Check out our [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
+Want to help build *Taipy*? Check out our [`CONTRIBUTING.md`](../../CONTRIBUTING.md) file.
 
 ## Code of conduct
 
-Want to be part of the _Taipy_ community? Check out our
+Want to be part of the *Taipy* community? Check out our
 [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) file.
 
 ## Directory Structure
@@ -61,10 +61,10 @@ Want to be part of the _Taipy_ community? Check out our
       - `{{cookiecutter.__root_folder_name}}/`: The root folder of the application created using this template.
       - `hooks/`: Contains hooks to be executed before and after the application is created.
       - `cookiecutter.json`: The configuration file for the template.
-    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-templates_.
-    - `CONTRIBUTING.md`: Instructions to contribute to _taipy-templates_.
+    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of *taipy-templates*.
+    - `CONTRIBUTING.md`: Instructions to contribute to *taipy-templates*.
     - `LICENSE`: The Apache 2.0 License.
     - `README.md`: Current file.
-    - `setup.py`: The setup script managing building, distributing, and installing _taipy-templates_.
+    - `setup.py`: The setup script managing building, distributing, and installing *taipy-templates*.
 - `tests/`:
   - `templates/`: Unit tests following the `taipy/templates/` structure.