Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Docs: Add and hide callout from the documentation #2625

Merged
merged 24 commits into from
Jul 18, 2024

Conversation

louismaximepiton
Copy link
Member

@louismaximepiton louismaximepiton commented Jul 16, 2024

Note: Please transform - [ ] into - (NA) in the description when things are not applicable

Related issues

Supersedes #1614 and #2001.
Closes #2128.

Description

Links have a component or guidelines word inside to let people know that the link goes on Boosted or the DSM.
If one example is fine, it should appear before the details/summary.
Use See Bootstrap example(s) that are incompatible with Orange Design System. sentence in the summary.
Use small sentences to explain why the example isn't good.

Motivation & Context

Before long term maintenance.

Types of change

  • Docs enhancement (non-breaking change which adds functionality)

Live previews

Checklist

Contribution

Accessibility

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

Design

  • My change respects the design guidelines defined in Orange Design System
  • My change is compatible with a 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 well displayed 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
  • Design review
  • A11y review

After the merge

@louismaximepiton louismaximepiton added v5 📖 documentation Improvements or additions to documentation 🧩 enhancement labels Jul 16, 2024
Copy link

netlify bot commented Jul 16, 2024

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 74e5cd2
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/6698e80d6bf74800080e388b
😎 Deploy Preview https://deploy-preview-2625--boosted.netlify.app
📱 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 configuration.

@julien-deramond julien-deramond changed the title [OUDS] Docs: Add and hide callout from the documentation Docs: Add and hide callout from the documentation Jul 16, 2024
@louismaximepiton louismaximepiton force-pushed the main-lmp-add-design-callouts-in-docs branch from 4f2013b to fbffa84 Compare July 17, 2024 14:11
@louismaximepiton louismaximepiton marked this pull request as ready for review July 17, 2024 14:12
@julien-deramond julien-deramond force-pushed the main-lmp-add-design-callouts-in-docs branch from fbffa84 to f84d102 Compare July 18, 2024 04:59
- Change wording and add various design callouts about the incompatibility with ODS
- Add missing examples from Bootstrap within `<details><summary>`

Co-authored by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Co-authored by: Hannah Issermann <hannah.issermann@orange.com>
Co-authored by: Julien Déramond <julien.deramond@orange.com>
@julien-deramond julien-deramond self-requested a review July 18, 2024 10:12
Copy link
Contributor

@julien-deramond julien-deramond left a comment

Choose a reason for hiding this comment

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

Great job!

@julien-deramond julien-deramond merged commit cbea7f3 into main Jul 18, 2024
14 checks passed
@julien-deramond julien-deramond deleted the main-lmp-add-design-callouts-in-docs branch July 18, 2024 10:32
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
📖 documentation Improvements or additions to documentation 🧩 enhancement v5
Projects
Development

Successfully merging this pull request may close these issues.

Design callout messages: make included links accessible
2 participants