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

revising data model for EDU Lesson procedures #579

Merged
merged 4 commits into from
Aug 28, 2024

Conversation

stephiescastle
Copy link
Member

@stephiescastle stephiescastle commented Aug 28, 2024

Checklist

  • Include a description of your pull request and instructions for the reviewer to verify your work.
  • Link to the issue if this PR is issue-specific.
  • Create/update the corresponding story if this includes a UI component.
  • Create/update documentation. If not included, tell us why.
  • List the environments / browsers in which you tested your changes.
  • Tests, linting, or other required checks are passing.
  • PR has an informative and human-readable title
    • PR titles are used to generate the change log in releases; good ones make that easier to scan.
    • PRs will be broadly categorized in the change log, but for even easier scanning, consider prefixing with a component name or other useful categorization, e.g., "BaseButton: fix layout bug", or "Storybook: Update dependencies".
  • PR has been tagged with a SemVer label and a general category label, or skip-changelog.
    • These tags are used to do the aforementioned broad categorization in the change log and determine what the next release's version number should be.
    • Release Drafter will attempt to do the category labeling for you! Please double-check its work.

Description

Supports https://github.com/nasa-jpl/www/issues/413

  • Revises data structure for lesson procedures

Caveats

  • When using steps numbering, the first item in the "step" should be a rich text block (or similarly narrow block), otherwise the number will be covered up by wider media blocks.

Instructions to test

  1. make vue-storybook
  2. View the PageEduLessonDetail story

Tested in the following environments/browsers:

Operating System

  • macOS
  • iOS
  • iPadOS
  • Windows

Browser

  • Chrome
  • Firefox ESR
  • Firefox
  • Safari
  • Edge

@Scotchester
Copy link
Member

When using steps numbering, the first item in the "step" should be a rich text block (or similarly narrow block), otherwise the number will be covered up by wider media blocks.

@kimorr @otalutz Do you think this will be an acceptable limitation? Will most steps start with text?

Headings at levels larger than 4 look pretty funky due to the baselines of the number and the heading being far apart, but most likely and heading within one of these steps should be an H4, since "Procedures" is an H2 and procedure section headings would be H3.

Copy link
Member

@Scotchester Scotchester left a comment

Choose a reason for hiding this comment

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

This is working pretty well for me! Just a couple needed changes in the stories, I think.

Comment on lines 76 to 84
<!-- <LayoutHelper
v-if="procedureSteps"
indent="col-3"
class="lg:mb-8 mb-5"
>
<BaseHeading level="h3">
{{ 'Section ' + (Number(index) + 1) }}
</BaseHeading>
</LayoutHelper>
</LayoutHelper> -->
Copy link
Member

Choose a reason for hiding this comment

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

Did you mean to leave this in but commented?

Comment on lines 159 to 161
// &::marker {
// content: counter(step) '. ';
// }
Copy link
Member

Choose a reason for hiding this comment

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

Did you want to save this commented block and the ones further down?

{
blocks: BlockStreamfieldMinimalData.body
}
]
},
Copy link
Member

Choose a reason for hiding this comment

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

I think the two procedures items below here should probably be removed? They don't appear to be causing a problem, but they don't do anything, either.

stephiescastle and others added 2 commits August 28, 2024 10:56
…ries.js

Co-authored-by: Scott Cranfill <scott.cranfill@jpl.nasa.gov>
@stephiescastle
Copy link
Member Author

This is working pretty well for me! Just a couple needed changes in the stories, I think.

Made the changes! Forgot to do a lot of cleanup before opening the PR 🤦 thanks for the review!

Copy link
Member

@Scotchester Scotchester left a comment

Choose a reason for hiding this comment

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

LGTM! We can revisit if my question for Kim and Ota necessitates it.

@stephiescastle stephiescastle merged commit 4d6273e into main Aug 28, 2024
6 checks passed
@stephiescastle stephiescastle deleted the feature/lesson-procedures branch August 28, 2024 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants