Skip to content

Add links from settings to documentation #23

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

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Add links from settings to documentation #23

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
045b3ea
Add link to Linked Record doc
louisdorard Oct 27, 2025
3496e3a
Update description for editschema
louisdorard Oct 27, 2025
0764f5c
Test
louisdorard Oct 27, 2025
b0f3fc2
Move link
louisdorard Oct 27, 2025
62dacd5
Add missing quotes
louisdorard Oct 27, 2025
95ae76f
Fix typo
louisdorard Oct 27, 2025
590eb16
Point editschema description to documentation
louisdorard Oct 27, 2025
a6bb6b8
Test line break
louisdorard Oct 27, 2025
cd5392a
Remove line breaks as they are not rendered
louisdorard Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions dss-plugin-visual-edit/webapps/visual-edit/webapp.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,23 @@
{
"name": "primary_keys",
"label": "Primary Keys",
"description": "Columns used to identify a record.\n\nIMPORTANT: make sure that the type and meaning of these columns is set correctly before starting the webapp.",
"description": "Columns used to identify a record. IMPORTANT: make sure that the type and meaning of these columns is set correctly before starting the webapp.",
"type": "DATASET_COLUMNS",
"datasetParamName": "original_dataset",
"mandatory": true
},
{
"name": "editable_column_names",
"label": "Editable Columns",
"description": "Columns that the webapp user will be able to edit.\n\nIMPORTANT: make sure that the type and meaning of these columns is set correctly before starting the webapp.",
"description": "Columns that the webapp user will be able to edit. IMPORTANT: make sure that the type and meaning of these columns is set correctly before starting the webapp.",
"type": "DATASET_COLUMNS",
"datasetParamName": "original_dataset",
"mandatory": true
},
{
"name": "sep-linked-record",
"label": "Linked Records",
"description": "A linked record (aka foreign key) is an editable column whose values correspond to primary key values of another dataset, referred to as the linked dataset.",
"description": "A Linked Record (aka Foreign Key) column is an editable column whose values correspond to Primary Key values of another dataset, referred to as the Linked Dataset. [Read more >](https://dataiku.github.io/dss-visual-edit/linked-records)",
"type": "SEPARATOR"
},
{
Expand Down Expand Up @@ -171,11 +171,12 @@
{
"name": "sep-advanced",
"label": "Advanced",
"description": "Restrict access to a list of authorized users, freeze edits, activate debug mode, or customize editing widgets via the [Editschema](https://dataiku.github.io/dss-visual-edit/editschema).",
"type": "SEPARATOR"
},
{
"name": "authorized_users",
"label": "Authorized users",
"label": "Authorized users (optional)",
"description": "List identifiers of users authorized to view the webapp and make edits, as Strings. Leave empty to give access to anyone who has project-level permission to read dashboards.",
"type": "ARRAY"
},
Expand All @@ -193,9 +194,9 @@
{
"name": "editschema",
"label": "Editschema (optional)",
"description": "Additional column settings to provide as an array of dictionaries in JSON format (example: [ {'name': 'col1'}, {'name': 'col2'} ]",
"description": "See link above for more information.",
"type": "TEXTAREA"
}
],
"roles": []
}
}