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.

Sign up for GitHub

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

Jump to bottom

Core notification documentation #416

Closed
1 of 2 tasks
toan-quach opened this issue Apr 7, 2023 · 9 comments
Closed
1 of 2 tasks

Core notification documentation #416

toan-quach opened this issue Apr 7, 2023 · 9 comments
Assignees
@toan-quach
Labels
Core Related to Taipy Core 📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature. 🟧 Priority: High Stalls work on the project or its dependents 🔒 Staff only Restricted to CC staff members

Comments

@toan-quach
Copy link
Member

toan-quach commented Apr 7, 2023 •
edited by jrobinAV
Loading

Description
Add documentation for the new notification mechanism in core.
Follows ticket taipy-#405.

Expected change
@toan-quach toan-quach added the 📈 Improvement Improvement of a feature. label Apr 7, 2023
@jrobinAV jrobinAV added Core Related to Taipy Core 📄 Documentation Internal or public documentation labels Apr 11, 2023
@jrobinAV jrobinAV added the 🟨 Priority: Medium Not blocking but should be fixed soon label Jun 5, 2023
@jrobinAV jrobinAV added the 🔒 Staff only Restricted to CC staff members label Oct 9, 2023
@jrobinAV jrobinAV mentioned this issue May 21, 2024
Closed
1 task
@jrobinAV
Copy link
Member

Blocked by doc-#709.

@jrobinAV jrobinAV added the ❌ Blocked Issue is blocked label May 21, 2024
@jrobinAV jrobinAV mentioned this issue Jul 17, 2024
Closed
3 tasks
@jrobinAV
Copy link
Member

Here is a proposed structure

Structure

This is under the SDM page:

  1. Listening SDM events => events/index.md
  2. Understanding topics => events/understanding-topics.md
  3. Events description => events/events-descriptions.md
  4. Advanced Examples => events/examples.md

1. Listening SDM events

  1. What is a topic (high-level definition) - Cross ref to page 2 for more details
  2. What is an event (high-level definition) - Cross ref to page 3 for more details
  3. Why register for topics with practical use cases
  4. How to overview - Should explain we need to register to a topic and implement a consumer
  5. Simple but complete example

2. Understanding Topics

  1. What is a topic
  2. How to register for one topic
  3. Examples: Code snippets and explanations.

3. Events List

  • What is an event
  • The exhaustive list of events. Should it be categorized by entity type? (or maybe by operation???)
    For each event:
    - Brief description of each event.
    - Attributes associated with each event.
  • How to consume and process events
    Explanation of event consumption process.
    Code examples for processing and handling events.

4. Examples:

A few complete examples with detailed explanation, step-by-step guide and code sample

  • Consuming Scenario creation events and notifying the User in the user interface
  • Consuming an output Data node edition and call a fake rest API with the new data and the comment attached to the last edition
  • Consuming Job failure events and send an email to an admin user
  • etc.

@jrobinAV jrobinAV added 🟧 Priority: High Stalls work on the project or its dependents and removed ❌ Blocked Issue is blocked 🟨 Priority: Medium Not blocking but should be fixed soon labels Jul 18, 2024
@FlorianJacta
Copy link
Member

Seems great!

@toan-quach toan-quach self-assigned this Jul 23, 2024
@toan-quach toan-quach mentioned this issue Jul 24, 2024
Merged
@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 6, 2024

This issue has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this issue, please add another comment or create a PR that links to this issue. If a PR has already been created which refers to this issue, then you should explicitly mention this issue in the relevant PR. Otherwise, you will be unassigned in 14 days. For more information please refer to the contributing guidelines.

@github-actions github-actions bot added the 🥶Waiting for contributor Issues or PRs waiting for a long time label Aug 6, 2024
@trgiangdo trgiangdo removed the 🥶Waiting for contributor Issues or PRs waiting for a long time label Aug 6, 2024
@github-actions GitHub Actions
Copy link

This issue has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this issue, please add another comment or create a PR that links to this issue. If a PR has already been created which refers to this issue, then you should explicitly mention this issue in the relevant PR. Otherwise, you will be unassigned in 14 days. For more information please refer to the contributing guidelines.

@github-actions github-actions bot added the 🥶Waiting for contributor Issues or PRs waiting for a long time label Aug 21, 2024
@jrobinAV
Copy link
Member

The PR 1047 is in progress.
It remains a couple of things (the example page, the mkdocs.yml_template update, etc.) but should be reviewed and approved soon.

@jrobinAV jrobinAV removed the 🥶Waiting for contributor Issues or PRs waiting for a long time label Aug 22, 2024
jrobinAV added a commit that referenced this issue Sep 3, 2024
@toan-quach @jrobinAV
feature/#416 documentation for core notification (#1047)
4c2845a 
* added simple documentation for core notification

* moved topic content from event to topic file

* added info about event

* added more info about consumer

* change doc

* change doc

* added flake8

* added examples

* Update docs/manuals/userman/sdm/events/code-example/user-changes-notifier.py

Co-authored-by: Jean-Robin <[email protected]>

* Update docs/manuals/userman/sdm/events/code-example/user-changes-notifier.py

Co-authored-by: Jean-Robin <[email protected]>

* added examples and minor fixes

---------

Co-authored-by: Toan Quach <[email protected]>
Co-authored-by: Jean-Robin <[email protected]>
@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 5, 2024

This issue has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this issue, please add another comment or create a PR that links to this issue. If a PR has already been created which refers to this issue, then you should explicitly mention this issue in the relevant PR. Otherwise, you will be unassigned in 14 days. For more information please refer to the contributing guidelines.

@github-actions github-actions bot added the 🥶Waiting for contributor Issues or PRs waiting for a long time label Sep 5, 2024
@jrobinAV
Copy link
Member

jrobinAV commented Sep 5, 2024

The first PR has been merged. However, the example page should be improved.
Each example should have an introductory paragraph explaining the interest, motivation, and purpose of the use case.

@jrobinAV jrobinAV removed the 🥶Waiting for contributor Issues or PRs waiting for a long time label Sep 5, 2024
toan-quach added a commit that referenced this issue Sep 12, 2024
@toan-quach
Merge pull request #1120 from Avaiga/feature/#416-core-notification-d…
4220977 
…ocumentation

Feature/#416 core notification documentation
@jrobinAV
Copy link
Member

Can it be moved to done?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@toan-quach toan-quach

Labels
Core Related to Taipy Core 📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature. 🟧 Priority: High Stalls work on the project or its dependents 🔒 Staff only Restricted to CC staff members
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@trgiangdo @jrobinAV @toan-quach @FlorianJacta