Apply pattern to the post when selected #5179

renatho · 2022-05-24T20:48:43Z

Fixes #5140
Fixes #5130
Fixes #5133

Changes proposed in this Pull Request

This PR has some general fixes (sorry for that in this PR), but the main goal is to apply the pattern correctly when it's chosen.
It also finalizes the pattern steps for course and lesson with the proper styles and content.

Testing instructions

Create a new course.
In the wizard form, add a title and a description.
Navigate through the steps until the "Course Layout".
Click in a pattern.
Make sure it's applied to the course with the title and description replaced, and the course is saved.
Repeat the test, but close the modal instead of choosing a pattern.
Make sure the modal is closed, the default template is used in the course, and the course is saved.
Also make sure that the pattern selection work on a new lesson.

Screenshot / Video

Screen.Recording.2022-05-26.at.16.21.09.mov

renatho · 2022-05-26T19:24:58Z

assets/admin/editor-wizard/steps/course-patterns-step.js


-	// We can call `onCompletion` to complete the wizard after setting the correct pattern with `setData`.
-	// We could replace `onCompletion` with the `goToNextStep` callback with a similar effect.
+	if ( data.courseTitle ) {


When we implement the final patterns, if we don't have a course title to replace, we can remove this condition.

aaronfc

Looks good!
Just some clarifications:

Lesson step will need to be implemented after this is integrated, right?
I saw that Course Outline is added with some default lessons, which is nice, but it is not when using the default template (course outline appears without lessons) – this will be fixed here, right?

assets/admin/editor-wizard/steps/lesson-patterns-step.js

assets/admin/editor-wizard/steps/patterns-step.test.js

assets/admin/editor-wizard/wizard.js

aaronfc · 2022-05-27T08:54:13Z

assets/admin/editor-wizard/wizard.js

 							/>
 						</div>
 					) }
 				</div>
 			</div>
-		) ) ||
-		null
+		)


I remember needing to add this || null because I was getting an error that a render should return something always. Why it is not needed anymore?

Ah, I got it! If steps[ currentStepNumber ] is undefined it would fire an error. But if we return null we also have a weird behavior with the modal open, but only with the overlay.

Thinking a little more, I don't think we need this check since goToNextStep will only increment if we have steps. I removed it for now in this commit: d64d74e, but let me know if I'm missing anything. 😉

I also removed the conditional in the other case where steps should always be an array.

…sensei into add/pattern-selection

renatho · 2022-05-27T14:10:09Z

Thank you for your review, @aaronfc !

Lesson step will need to be implemented after #5194 is integrated, right?

Definitely! Good catch! I already updated the branch, since that was merged, and added the implementation here: 24207ca

I saw that Course Outline is added with some default lessons, which is nice, but it is not when using the default template (course outline appears without lessons) – this will be fixed #5196, right?

That's correct! Also about the format of the Outline in the patterns, it's something temporary, I think it will depend on how we define them.

aaronfc

Looks good works well :D

alexsanford · 2022-05-30T18:11:53Z

When I test this (on the feature branch), and either close the modal or click "Start with default layout" (rather than selecting a pattern), it seems like the description that I've added to the modal is lost (it's not added to the post at all). Is this intentional? Should we have some way of adding the description to the default template? Or are we ok with just losing the description if the modal is closed?

My thought is we should have the description in the default template somewhere.

cc @renatho @burtrw

renatho · 2022-05-30T19:26:32Z

it seems like the description that I've added to the modal is lost (it's not added to the post at all). Is this intentional?

Good point! For now, it was intentional, just applying the description to the patterns. And when skipping, it just loads the default template. But I think it makes sense. Maybe we could add a paragraph with the filled description.

If we go for that, I have a question if the user doesn't add any information to the description input. In the case of the patterns, we're keeping the original content of the pattern. Maybe should we also have a paragraph with an example text in the default template?

burtrw · 2022-05-30T19:43:11Z

I was thinking the description could/should also get applied as the Course 'excerpt' if that is possible?

But adding a simple text block at the top of the default that includes the description would also be great.

We could either just put a blank paragraph block where the description would go or have default text. My concern with default text is translations (though we are adding default text to other patterns...).

What do y'all think would be best?

renatho · 2022-05-31T14:26:35Z

I was thinking the description could/should also get applied as the Course 'excerpt' if that is possible?

Yep. It's possible to do it in a similar way to how we update the title currently.

But adding a simple text block at the top of the default that includes the description would also be great.

We could either just put a blank paragraph block where the description would go or have default text. My concern with default text is translations (though we are adding default text to other patterns...).

What do y'all think would be best?

IMO, I think since it's the default template and not a styled pattern, we could just leave an empty paragraph if the user doesn't inform a description. We could have a placeholder there how we have in the current lesson editor "Write lesson content..."

I wait for confirmation or a new suggestion to open an issue for that. 😉

renatho added the [Type] Enhancement label May 24, 2022

renatho added this to the Course and Lesson Wizard milestone May 24, 2022

renatho self-assigned this May 24, 2022

renatho force-pushed the add/pattern-selection branch from 87539e9 to a8c0a64 Compare May 25, 2022 21:00

renatho mentioned this pull request May 26, 2022

Add some samples as Sensei patterns #5173

Merged

Base automatically changed from add/sensei-patterns to feature/course-lesson-wizard May 26, 2022 14:23

renatho force-pushed the add/pattern-selection branch 2 times, most recently from 98af7e0 to 828a1ae Compare May 26, 2022 17:35

renatho added 15 commits May 26, 2022 15:26

Fix footer spacing

4c89411

Update logic to set pattern after chosen

4dbbe68

Save post on wizard completion

c7b3929

Add class to sensei title and description

55aa555

Fill the patterns content with user input

4dfcf07

Unify patterns step

88b15e8

Update close hover color because the background on the patterns is white

4447628

Fix wizard footer

5cf5cfa

Set title sticky on the patterns step

3736608

Remove paragraph from Patterns step

e9104f1

Add steps counter translation

3fb8503

Simplify return

610dbbe

Add custom title to lesson and course steps

7c28019

Refactor selection responsability

bc925f2

Simplify return

2d73216

renatho force-pushed the add/pattern-selection branch from 7cf8547 to 2d73216 Compare May 26, 2022 18:26

Refactor placeholders replacement

4ab922d

renatho force-pushed the add/pattern-selection branch from 1cbc1ec to 4ab922d Compare May 26, 2022 19:13

renatho commented May 26, 2022

View reviewed changes

renatho added 2 commits May 26, 2022 16:38

Add tests for pattern placeholders replace

6cfbee5

Add tests to replace placeholders

f118acb

renatho requested a review from a team May 26, 2022 19:41

renatho marked this pull request as ready for review May 26, 2022 19:41

aaronfc previously approved these changes May 27, 2022

View reviewed changes

renatho dismissed aaronfc’s stale review via 946f50d May 27, 2022 13:55

Remove conditional from component returns

d64d74e

renatho force-pushed the add/pattern-selection branch from 946f50d to d64d74e Compare May 27, 2022 13:59

renatho added 2 commits May 27, 2022 11:04

Merge branch 'feature/course-lesson-wizard' of github.com:Automattic/…

c2147d7

…sensei into add/pattern-selection

Add lesson title replacement

24207ca

renatho requested a review from aaronfc May 27, 2022 14:10

aaronfc approved these changes May 30, 2022

View reviewed changes

renatho merged commit 8f543a0 into feature/course-lesson-wizard May 30, 2022

renatho deleted the add/pattern-selection branch May 30, 2022 13:55

This was referenced May 31, 2022

Get the initial lesson title from the store and set the excerpt with the description #5213

Closed

Add paragraph with description in default template #5221

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Apply pattern to the post when selected #5179

Apply pattern to the post when selected #5179

renatho commented May 24, 2022 •

edited

Loading

renatho May 26, 2022

aaronfc left a comment

aaronfc May 27, 2022

renatho May 27, 2022 •

edited

Loading

renatho May 27, 2022

renatho commented May 27, 2022 •

edited

Loading

aaronfc left a comment

alexsanford commented May 30, 2022

renatho commented May 30, 2022

burtrw commented May 30, 2022

renatho commented May 31, 2022

Apply pattern to the post when selected #5179

Apply pattern to the post when selected #5179

Conversation

renatho commented May 24, 2022 • edited Loading

Changes proposed in this Pull Request

Testing instructions

Screenshot / Video

renatho May 26, 2022

Choose a reason for hiding this comment

aaronfc left a comment

Choose a reason for hiding this comment

aaronfc May 27, 2022

Choose a reason for hiding this comment

renatho May 27, 2022 • edited Loading

Choose a reason for hiding this comment

renatho May 27, 2022

Choose a reason for hiding this comment

renatho commented May 27, 2022 • edited Loading

aaronfc left a comment

Choose a reason for hiding this comment

alexsanford commented May 30, 2022

renatho commented May 30, 2022

burtrw commented May 30, 2022

renatho commented May 31, 2022

renatho commented May 24, 2022 •

edited

Loading

renatho May 27, 2022 •

edited

Loading

renatho commented May 27, 2022 •

edited

Loading