Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc/home update #560

Merged
merged 6 commits into from
Sep 18, 2023
Merged

Doc/home update #560

merged 6 commits into from
Sep 18, 2023

Conversation

erikfTW
Copy link
Contributor

@erikfTW erikfTW commented Sep 17, 2023

I applied feedback comments from Vincent, thanks.

Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Please ensure your lines have a maximum length of 100 characters. It makes it easier to review and maintain.

  2. It is still too long for me. Consequently, it's difficult for a reader to capture the essence of the message provided on the home page.

  3. The content is disorganized to me. Here is what we have today.

  • We talk abt Taipy purpose:
    Taipy is an open-source Python library designed to build both the front-end and back-end of
    your applications. Taipy is easy to learn while providing all the features required to cover
    the whole software cycle: from prototypes/pilots all the way to deployment/production.
  • We talk abt gui is easy to learn and customizable:
    Taipy’s front-end makes it easy to create interactive, multi-users, multi-page dashboards. Yet, Taipy provides all the customization possibilities (graphical event management, delay management, etc) required by developers and end-users.
  • We talk abt Scenario mgt:
    At the same time, Taipy is designed for creating data-driven back-end applications. It comes with built-in components that make it easy to organize and control how data is accessed and managed.
  • We talk abt studio:
    Pipeline orchestration is very easy to implement through a graphical editor (Taipy Studio) and an intuitive Python API.
  • We get back on Scenario mgt:
    The capability to Register pipeline single execution, Perform what-if analysis (comparing different executions/runs), Explore your past executions, comparing them is provided by Taipy’s “Scenario Management”, one of Taipy’s central concepts.
  • We get back on Front-end:
    Taipy provides all the GUI components needed to build interactive front-ends. No prior knowledge of web design is necessary, and any prerequisites related to CSS and HTML. Leveraging augmented Markdown syntax, Taipy GUI aids users in seamlessly generating their desired web pages. Taipy’s ability to really customize your GUI in terms of layout, graphical events, Style/CSS, etc. is one of Taipy’s strongest points.
  • We get back on Scenario mgt:
    Taipy provides extensive support for orchestrating resilient pipelines capable of managing diverse situations.
    Enhancing the overall performance of Taipy applications, task caching, parallel executions of tasks, data source scoping are all integrated. Providing a registry of pipeline executions.
    Taipy equips users with the ability to monitor and assess the performance of their applications using the KPI tracking tool.
    Taipy offers built-in graphical explorers for visualizing, editing, and monitoring your past ‘executed’ pipelines and their associated data.

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
tools/config_doc.txt Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
- Taipy offers built-in graphical explorers for visualizing, editing, and monitoring your ‘executed’
pipelines and their associated data.
- Taipy equips users with the ability to monitor and assess the performance of their applications using the KPI tracking tool.
- Taipy offers built-in graphical explorers for visualizing, editing, and monitoring your past ‘executed’ pipelines and their associated data.

## Overview of Taipy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the end, I believe this illustration should not be on the homepage. Eventually on the user manual index page to get an overview of the way it works. But surely not on the Doc Homepage.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then I would move it to Getting Started, as the diagram is important to understand Taipy. In the User Manual, it will be lost a bit, or too late to review after they went via the Getting started.

docs/index.md Show resolved Hide resolved
erikfTW and others added 2 commits September 18, 2023 12:36
Applied Jean-Robin restructure feedback
@erikfTW erikfTW requested a review from jrobinAV September 18, 2023 10:41
@erikfTW erikfTW merged commit 67e58c8 into develop Sep 18, 2023
1 check passed
@erikfTW erikfTW deleted the doc/home-update branch September 18, 2023 16:39
arcanaxion pushed a commit to arcanaxion/taipy-doc that referenced this pull request Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants