-
Notifications
You must be signed in to change notification settings - Fork 45
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] Add shape on creating a representation from another representation #3428
[doc] Add shape on creating a representation from another representation #3428
Conversation
doc/iterations/2024.5/shapes/create_representation_using_content_of_another_representation.adoc
Outdated
Show resolved
Hide resolved
doc/iterations/2024.5/shapes/create_representation_using_content_of_another_representation.adoc
Outdated
Show resolved
Hide resolved
doc/iterations/2024.5/shapes/create_representation_using_content_of_another_representation.adoc
Outdated
Show resolved
Hide resolved
doc/iterations/2024.5/shapes/create_representation_using_content_of_another_representation.adoc
Outdated
Show resolved
Hide resolved
5c197bd
to
b4ed497
Compare
|
||
== Context | ||
|
||
Representation event processors are isolated on purpose, but now we want to be able to synchronize the state of a representation event processor with another one. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a more limited use case that what is described here, but note that the Representations view (in the right panel) supports displaying the structure/contents of a Portal representation (see #2897).
Signed-off-by: Gwendal Daniel <gwendal.daniel@obeosoft.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll rebase it and merge it but the content of the document is a bit odd.
On one side, shapes are made to describe the behavior we want to have and ADR are made to describe how we believe we implement do it. Here you have a shape talking almost exclusively about the technical details behind the feature you want to implement. And contrary to most ADR, it's a bit more a work in progress of how you found out you could to it.
That's not really an issue but in the end it feels a bit more like a "How to" document (see /doc/how-to
) explaining how to create a representation using another representation as an input than either a shape or an ADR. It's still very interesting to have in the repository but we may move it / copy it there once it's fully done.
|
||
We want: | ||
|
||
- To compute a representation in a representation event processor with the sate of another representation as input (e.g. a form using a diagram as input) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sate
-> state
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've fixed it
b4ed497
to
52f78d1
Compare
Pull request template
General purpose
What is the main goal of this pull request?
Project management
priority:
andpr:
labels been added to the pull request? (In case of doubt, start with the labelspriority: low
andpr: to review later
)area:
,difficulty:
,type:
)CHANGELOG.adoc
been updated to reference the relevant issues?CHANGELOG.adoc
? (Including changes in the GraphQL API)CHANGELOG.adoc
? For example indoc/screenshots/2022.5.0-my-new-feature.png
Architectural decision records (ADR)
[doc]
?CHANGELOG.adoc
?Dependencies
CHANGELOG.adoc
?CHANGELOG.adoc
?Frontend
This section is not relevant if your contribution does not come with changes to the frontend.
General purpose
Typing
We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).
useMutation<DATA_TYPE, VARIABLE_TYPE>(…)
useQuery<DATA_TYPE, VARIABLE_TYPE>(…)
useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)
useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)
useState<STATE_TYPE>(…)
?.
(if the GraphQL API specifies that a field cannot benull
, do not treat it has potentiallynull
for example)let diagram: Diagram | null = null;
)Backend
This section is not relevant if your contribution does not come with changes to the backend.
General purpose
Architecture
Review
How to test this PR?
Please describe here the various use cases to test this pull request