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

Update stepped process documentation #1908

Merged
merged 6 commits into from
Mar 27, 2023

Conversation

MewenLeHo
Copy link
Contributor

@MewenLeHo MewenLeHo commented Mar 20, 2023

Related issues

Closes #1868

Description

I added a callout message to inform our users about the $stepped-process-max-items variable.

Motivation & Context

Have a better documentation for the stepped process component.

Types of change

  • Refactoring (non-breaking change)

Live previews

Checklist

Contribution

Accessibility

  • (NA) My change follows accessibility good practices; I have at least run axe

Design

  • (NA) My change respects the design guidelines defined in Orange Design System
  • (NA) My change is compatible with responsive display

Development

  • My change follows the developer guide
  • (NA) I have added JavaScript unit tests to cover my changes
  • (NA) I have added SCSS unit tests to cover my changes

Documentation

  • My change introduces changes to the documentation and/or I have updated the documentation accordingly

Checklist (for Core Team only)

  • My change introduces changes to the migration guide
  • (NA) My new component is added in Storybook
  • (NA) My new component is compatible with RTL
  • (NA) Manually run BrowserStack tests
  • (NA) Manually test browser compatibility with BrowserStack (Chrome >= 60, Firefox >= 60 (+ ESR), Edge, Safari >= 12, iOS Safari, Chrome & Firefox on Android)
  • Code review
  • (NA) Design review
  • (NA) A11y review

After the merge

@MewenLeHo MewenLeHo added v5 docs Improvements or additions to documentation enhancement labels Mar 20, 2023
@netlify
Copy link

netlify bot commented Mar 20, 2023

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit a1a21b6
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/64213f3bceee66000810b947
😎 Deploy Preview https://deploy-preview-1908--boosted.netlify.app/docs/5.3/components/stepped-process
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@MewenLeHo
Copy link
Contributor Author

MewenLeHo commented Mar 20, 2023

Questions waiting for your opinions:

  • Should this information be in a callout or not?
  • Should we rename the $stepped-process-max-items variable because it's not really a limitation as explained in the related issue. More like a $stepped-process-number-of-items variable. But it will be a breaking change and I am not sure if it's really needed or not? 🤔

Copy link
Member

@louismaximepiton louismaximepiton left a comment

Choose a reason for hiding this comment

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

Should this information be in a callout or not?

I don't have a strong idea on this, feeling that it might be a bit better to let it inside a callout since it's new.

Should we rename the $stepped-process-max-items variable because it's not really a limitation as explained in the related issue. More like a $stepped-process-number-of-items variable. But it will be a breaking change and I am not sure if it's really needed or not? 🤔

I'd say keep it as-is since it might represents the maximum number of steps displayed in the website imo + keeping it like that might not break things, so I's agree to let it as-is.

site/content/docs/5.3/components/stepped-process.md Outdated Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented Mar 27, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@julien-deramond julien-deramond merged commit 899f0d8 into main Mar 27, 2023
@julien-deramond julien-deramond deleted the main-mlh-update-stepped-process-doc branch March 27, 2023 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement v5
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance Stepped Process desc to talk about max items
3 participants