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

docs: add documentation for transformed data section and variables #132

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

florianesser
Copy link
Member

Extend documentation for the Transformed data section of a dataset. Add documentation related to project variables and the use of placeholders to pass special values, e.g. {{dataset.id}}.

ING-4530

Copy link
Member

@morch23mj morch23mj left a comment

Choose a reason for hiding this comment

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

LGTM.

@florianesser florianesser merged commit 39de7af into master Dec 9, 2024
3 checks passed
@florianesser florianesser deleted the docs/transformed-data-project-variables branch December 9, 2024 13:46
Copy link
Member

@JohannaOtt JohannaOtt left a comment

Choose a reason for hiding this comment

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

Sorry, only getting around reviewing this now. Still added by comments.


Under Target data set, click the data set name to edit data set properties. Click the arrow button to download the transformed data set.
The page provides links to the transformation project and to the transformed dataset ("Target dataset"). The result of the last transformation run is shown near the bottom, together with a link to show the log output of the transformation run. "The Transformed types" table lists the number of occurrences of each type in the source data and the number of occurrences of each type in the target data.
Copy link
Member

Choose a reason for hiding this comment

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

Would it make sense to add an information on that is sometimes not working as expected? See https://wetransform.atlassian.net/browse/ING-1693 and https://wetransform.atlassian.net/browse/ING-1693


Under Last transformation result, you can view the status of the last transformation, the time it started, the time it finished and how long the transformation took to execute.
In case the transformation project contains variables, the "Project variables:" section gives access to these. The values of the variables can be changed here so that subsequent transformation runs (which can be triggered via the "Start transformation" button) will use the new values.
Copy link
Member

Choose a reason for hiding this comment

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


The Transformed types table lists the number of occurrences of each type in the source data and the number of occurrences of each type in the target data.
Another practical example for this feature is to pass the hale»connect dataset ID placholder `{{dataset.id}}` to the variable `DATASET_ID` of a XPlanung to INSPIRE transformation which is used to generate unique identifiers for `OfficialDocumentation` elements if the project variable `FORCE_UNIQUE_OFFICIALDOCUMENTATION_ID` is set to `true`.
Copy link
Member

Choose a reason for hiding this comment

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

placholder --> placeholder

@@ -9,14 +9,14 @@ sidebar_position: 8

---

Im «Abgeleitete Daten»-Bereich werden die Transformations-Projekte angezeigt, die mit dem ausgewählten Datensatz verbunden sind. Klicken sie auf den Namen des Transformations-Projektes oder das Pfeilsymbol um grundlegende Eigenschaften und den aktuellen Status der Transformation angezeigt zu bekommen.
Der Bereich Transformierte Daten zeigt die Transformationsprojekte an, die mit diesem Datensatz verbunden sind. Klicken Sie auf den Projektnamen, um allgemeine Eigenschaften und den aktuellen Status der Transformation anzuzeigen.
Copy link
Member

Choose a reason for hiding this comment

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

Sie --> sie

There is an agreement to write sie with a lower case s in the documentation.


Klicken sie unter «Projekt» auf den Namen des Transformations-Projektes, um die Eigenschaften des Projektes zu bearbeiten.
<img src={require("/images/help/de/dataset_transformed_data.png").default} alt="" title="The Transformed data section " className="img-responsive img-inline-help"/>
Copy link
Member

Choose a reason for hiding this comment

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

title of the image to be translated too?

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.

3 participants