Document type conversion UX/UI #1181

hexaltation · 2024-08-27T14:29:56Z

Context

Document Type conversion is available through API calls and API console. As a non technical document owner I want to be able to convert my document to Template or Tutorial and vice-versa easily in the UI.

Proposed solution

This PR implements figma design by @lusebille https://www.figma.com/design/wcpetFt6aOKzTszcvPPWLQ/%5B05%2F24%5D-Grist-Design?node-id=559-80548&t=1gSxqwNd6ZsiXdFO-1

The only point not implemented is the notification after modal confirmation.
As the page needs to be reloaded its not simple to notify for the successful change.

Related issues

fixes #1015

Has this been tested?

👍 yes, I added tests to the test suite
💭 no, because this PR is a draft and still needs work
🙅 no, because this is not relevant here
🙋 no, because I need help

test/nbrowser/DocTypeConversion.ts

fflorent

Some remarks so far

app/client/models/DocPageModel.ts

app/client/ui/DocumentSettings.ts

fflorent

Good job! This feature is promising!

Here are some comments I got.

Something that surprised me a bit is that when I:

converted a tutorial from the Template org to a regular doc;
made some changes;
converted back to a tutorial;

The tutorial did not run. Any idea?

I used the Grist Basic doc for that.

test/nbrowser/DocTypeConversion.ts

app/client/ui/DocumentSettings.ts

fflorent

I think there is an issue with the current implementation, as I cannot convert documents to tutorials or template when I tested your work manually. I suggested a change in the test to reveal the issue.

test/nbrowser/DocTypeConversion.ts

app/client/ui/DocumentSettings.ts

hexaltation · 2024-10-09T09:55:22Z

The two broken tests seems not to be linked with code modified by this PR.
Do you agree with that @fflorent ?

fflorent

If you need help or me to take some remarks, don't hesitate.

app/client/ui/DocumentSettings.ts

test/nbrowser/DocTypeConversion.ts

fflorent

Great job! 👏

app/client/ui/DocumentSettings.ts

test/nbrowser/DocTypeConversion.ts

github-actions · 2024-10-30T16:58:37Z

Deployed commit 2d14a48d6ed12176398a0048f86de3173b9bb432 as https://grist-hexaltation-grist-core-issue-1015-convert-document-to-template-tuto.fly.dev (until 2024-11-29T16:55:58.444Z)

app/client/models/DocPageModel.ts

app/client/ui/AdminPanelCss.ts

app/client/ui/DocumentSettings.ts

app/client/ui2018/checkbox.ts

app/client/ui/DocumentSettings.ts

github-actions · 2024-10-31T12:19:22Z

Deployed commit 0bc761c56ef32fd350a4a42044a6c2824711ecc1 as https://grist-hexaltation-grist-core-issue-1015-convert-document-to-template-tuto.fly.dev (until 2024-11-30T12:16:27.910Z)

static/icons/icons.css

static/ui-icons/UI/RadioButtonInnerCircle.svg

github-actions · 2024-10-31T13:04:21Z

Deployed commit 4eac14dba424a46b046c0acfad06dde6afcd4114 as https://grist-hexaltation-grist-core-issue-1015-convert-document-to-template-tuto.fly.dev (until 2024-11-30T13:00:55.012Z)

github-actions · 2024-10-31T19:49:51Z

Deployed commit 801611e40801277a37c3ea369f3d561b80a17601 as https://grist-hexaltation-grist-core-issue-1015-convert-document-to-template-tuto.fly.dev (until 2024-11-30T19:47:19.979Z)

fix: url deduction for page reload to apply new document type

TODO onboarding popup TODO better waiting for url change

@lusebille

…other PR design proposal by @lusebille -> https://www.figma.com/design/wcpetFt6aOKzTszcvPPWLQ/%5B05%2F24%5D-Grist-Design?node-id=559-80548&t=1gSxqwNd6ZsiXdFO-1

remove uneeded async and better function naming

…bs#1015

fix: various nitpicks

github-actions · 2024-11-26T14:47:24Z

Deployed commit 860d8c1d389c4cdd722d18ea4ffc8079c8088d01 as https://grist-hexaltation-grist-core-issue-1015-convert-document-to-template-tuto.fly.dev (until 2024-12-26T14:44:17.517Z)

hexaltation requested a review from fflorent August 27, 2024 14:30

hexaltation commented Aug 27, 2024

View reviewed changes

test/nbrowser/DocTypeConversion.ts Outdated Show resolved Hide resolved

hexaltation mentioned this pull request Aug 29, 2024

[Development] Some tests fail even when run on fresh clone #1185

Closed

2 tasks

fflorent suggested changes Sep 4, 2024

View reviewed changes

hexaltation force-pushed the issue-1015-convert-document-to-template-tuto branch from 71f3678 to 5d3449a Compare September 4, 2024 12:20

fflorent reviewed Sep 5, 2024

View reviewed changes

test/nbrowser/DocTypeConversion.ts Outdated Show resolved Hide resolved

app/client/ui/DocumentSettings.ts Outdated Show resolved Hide resolved

app/client/ui/DocumentSettings.ts Outdated Show resolved Hide resolved

hexaltation force-pushed the issue-1015-convert-document-to-template-tuto branch from 5d3449a to 9a21be7 Compare September 12, 2024 11:58

fflorent self-requested a review September 20, 2024 14:09

fflorent suggested changes Oct 2, 2024

View reviewed changes

test/nbrowser/DocTypeConversion.ts Outdated Show resolved Hide resolved

test/nbrowser/DocTypeConversion.ts Outdated Show resolved Hide resolved

fflorent reviewed Oct 7, 2024

View reviewed changes

app/client/ui/DocumentSettings.ts Outdated Show resolved Hide resolved

app/client/ui/DocumentSettings.ts Outdated Show resolved Hide resolved

app/client/ui/DocumentSettings.ts Outdated Show resolved Hide resolved

fflorent self-requested a review October 8, 2024 14:26

hexaltation force-pushed the issue-1015-convert-document-to-template-tuto branch from 92c4b15 to 6750cfd Compare October 9, 2024 09:38

fflorent suggested changes Oct 9, 2024

View reviewed changes

fflorent approved these changes Oct 9, 2024

View reviewed changes

app/client/ui/DocumentSettings.ts Outdated Show resolved Hide resolved

test/nbrowser/DocTypeConversion.ts Outdated Show resolved Hide resolved

test/nbrowser/DocTypeConversion.ts Show resolved Hide resolved

test/nbrowser/DocTypeConversion.ts Show resolved Hide resolved

fflorent approved these changes Oct 9, 2024

View reviewed changes

hexaltation force-pushed the issue-1015-convert-document-to-template-tuto branch from 769213b to 2d14a48 Compare October 23, 2024 12:37

hexaltation requested review from berhalak and georgegevoian October 30, 2024 07:14

berhalak self-assigned this Oct 30, 2024

hexaltation added the preview Launch preview deployment of this PR label Oct 30, 2024

berhalak requested changes Oct 30, 2024

View reviewed changes

hexaltation force-pushed the issue-1015-convert-document-to-template-tuto branch from 2d14a48 to 0bc761c Compare October 31, 2024 12:11

hexaltation commented Oct 31, 2024

View reviewed changes

static/icons/icons.css Outdated Show resolved Hide resolved

hexaltation commented Oct 31, 2024

View reviewed changes

static/ui-icons/UI/RadioButtonInnerCircle.svg Outdated Show resolved Hide resolved

hexaltation requested a review from berhalak October 31, 2024 20:20

hexaltation added 25 commits November 26, 2024 15:28

fix: after lsebille review

7d6130d

fix: following fflorent review

5e0d6d0

fix: invalid Document types

c9d9fe4

fix: url deduction for page reload to apply new document type

fix: removing wheel reinvention of urlStates

fa931be

tests: detection of save copy button

ed5998f

TODO onboarding popup TODO better waiting for url change

wip: fiddle

c05e698

fix: inconsistent tooltip test

a26ebe6

chore: code factorization

d492356

chore: factorize tests

eeac6d1

fix: minor typos

d059ada

fix: waiting time to pass CI

3ea8dca

style: Move all styling linked to document settings enhancement in an…

cf73e94

…other PR design proposal by @lusebille -> https://www.figma.com/design/wcpetFt6aOKzTszcvPPWLQ/%5B05%2F24%5D-Grist-Design?node-id=559-80548&t=1gSxqwNd6ZsiXdFO-1

fix: _buildDocumentTypeModal

9074038

remove uneeded async and better function naming

fix: ADD DOCTYPE_XXX symbols

a0768db

fix: move persist function to UserAPI class

bc84146

fix: empty string substitution for null doctype in PATCH doc

902e38c

fix: test after chrome driver updated to 130

643c162

feat: Change wording according to @dsagal suggestion in Issue gristla…

7b14298

…bs#1015

fix: check type key possible values in PATCH /api/docs/{did}

51f9498

fix: wording according to jr-grist remark on Issue gristlabs#1015

c25b034

fix: title and radio button margin

397852a

fix: ADD missing translation key

d30d810

feat: add tooltip on the feature

de525c3

fix: various nitpicks

fix: wrongly formatted json

9b71b8c

revert: remove tooltip

860d8c1

hexaltation force-pushed the issue-1015-convert-document-to-template-tuto branch from d0c5dcd to 860d8c1 Compare November 26, 2024 14:39

hexaltation requested a review from berhalak November 26, 2024 15:01

berhalak approved these changes Nov 27, 2024

View reviewed changes

berhalak merged commit 123ad18 into gristlabs:main Nov 27, 2024
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document type conversion UX/UI #1181

Document type conversion UX/UI #1181

hexaltation commented Aug 27, 2024

fflorent left a comment

fflorent left a comment

fflorent left a comment

hexaltation commented Oct 9, 2024

fflorent left a comment

fflorent left a comment

github-actions bot commented Oct 30, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Nov 26, 2024

Document type conversion UX/UI #1181

Document type conversion UX/UI #1181

Conversation

hexaltation commented Aug 27, 2024

Context

Proposed solution

Related issues

Has this been tested?

fflorent left a comment

Choose a reason for hiding this comment

fflorent left a comment

Choose a reason for hiding this comment

fflorent left a comment

Choose a reason for hiding this comment

hexaltation commented Oct 9, 2024

fflorent left a comment

Choose a reason for hiding this comment

fflorent left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 30, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Nov 26, 2024