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

docs: add design callouts in all the documentation when incompatibility with ODS #1614

Closed
wants to merge 71 commits into from

Conversation

isabellechanclou
Copy link
Member

@isabellechanclou isabellechanclou commented Nov 14, 2022

Related issues

Closes #1199
Closes #1118
Closes #1117

Description

Everywhere needed in Boosted Docs, a callout message has been added.

Motivation & Context

Callout messages added to warn Boosted users that such component or component variant should not be used because incompatible with the orange design system specifications.

Types of change

  • New feature (non-breaking change which adds functionality)

Live previews

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of the project (using npm run lint)
  • My change introduces changes to the documentation
  • My change introduces changes to the migration guide
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
…e of the design callouts on Getting started Introduction page

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
@netlify
Copy link

netlify bot commented Nov 14, 2022

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 4fcd51d
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/659bcea1f6fbd000083c8162
😎 Deploy Preview https://deploy-preview-1614--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.

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
@julien-deramond julien-deramond added feature docs Improvements or additions to documentation v5 labels Nov 14, 2022
@julien-deramond

This comment was marked as resolved.

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
@julien-deramond julien-deramond changed the title docs: add design callouts in all the documentation whent incompabilily with ODS docs: add design callouts in all the documentation when incompatibility with ODS Nov 15, 2022
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.

Here are some global comments, feel free to debate about these.

I'd rather use should not instead of can not almost everywhere in the callouts.
The way they are implemented yet make me feel that a callout is for the entire subpart.
Wondering if we should redirect to a usable Boosted variant on each callout ?
Maybe be more descriptive on some components.
Maybe we should on some examples explain why we shouldn't use this particular example but the concepts behind are still usable ?
We don't have specs for placeholders but is it fine to use them ?
Be brave for the migration guide change !

site/content/docs/5.2/components/badge.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/badge.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/button-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/button-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/button-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/modal.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/modal.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/carousel.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/list-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/navs-tabs.md Outdated Show resolved Hide resolved
@louismaximepiton louismaximepiton modified the milestone: m Nov 15, 2022
site/content/docs/5.2/customize/color.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/form-control.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/input-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/input-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/input-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/validation.md Outdated Show resolved Hide resolved
site/content/docs/5.2/getting-started/introduction.md Outdated Show resolved Hide resolved
site/content/docs/5.2/getting-started/introduction.md Outdated Show resolved Hide resolved
site/content/docs/5.2/getting-started/introduction.md Outdated Show resolved Hide resolved
site/content/docs/5.2/getting-started/introduction.md Outdated Show resolved Hide resolved
@hannahiss hannahiss self-requested a review November 18, 2022 16:00
Copy link
Member

@hannahiss hannahiss left a comment

Choose a reason for hiding this comment

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

Reviewed up to customize-colors included

site/content/docs/5.2/components/badge.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/badge.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/badge.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/button-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/button-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/progress.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/tooltips.md Outdated Show resolved Hide resolved
site/content/docs/5.2/content/reboot.md Outdated Show resolved Hide resolved
site/content/docs/5.2/customize/color.md Outdated Show resolved Hide resolved
site/content/docs/5.2/customize/color.md Outdated Show resolved Hide resolved
@louismaximepiton

This comment was marked as resolved.

site/content/docs/5.2/forms/form-control.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/input-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/input-group.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/layout.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/layout.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/layout.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/layout.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/layout.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/validation.md Outdated Show resolved Hide resolved
site/content/docs/5.2/getting-started/introduction.md Outdated Show resolved Hide resolved
site/content/docs/5.2/getting-started/introduction.md Outdated Show resolved Hide resolved
site/content/docs/5.2/getting-started/introduction.md Outdated Show resolved Hide resolved
site/content/docs/5.2/getting-started/introduction.md Outdated Show resolved Hide resolved
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
…ocs' into main-ic-add-design-callouts-in-docs

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
site/content/docs/5.3/components/button-group.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/list-group.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/navs-tabs.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/navs-tabs.md Outdated Show resolved Hide resolved
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
… >}} everywhere in the code

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
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.

Still some comments inside the PR to take into account but we're almost there I think.

site/content/docs/5.3/components/navs-tabs.md Outdated Show resolved Hide resolved
site/content/docs/5.2/components/navs-tabs.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/layout.md Outdated Show resolved Hide resolved
site/content/docs/5.2/forms/select.md Outdated Show resolved Hide resolved
site/content/docs/5.2/getting-started/introduction.md Outdated Show resolved Hide resolved
site/content/docs/5.3/forms/layout.md Show resolved Hide resolved
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
…ng the dark mode now available on main branch

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
@B3nz01d B3nz01d added this to Dev Review in 🟣 PR Board (Draft) Mar 29, 2023
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
@sonarcloud
Copy link

sonarcloud bot commented Apr 17, 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

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.

With the last changes, I'd rather set a global callout on badges to avoid hiding everything.
One .nav-underline.nav-justified render is broken.

Revert 4fcd51d if you don't like it.

@julien-deramond
Copy link
Member

Thanks a lot for this work. It has been gathered and merged with other modifications in #2625. All participants of this PR will be mentioned as co-authors in it.

@julien-deramond julien-deramond deleted the main-ic-add-design-callouts-in-docs branch July 18, 2024 05:06
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 feature v5
Projects
🟣 PR Board (Draft)
Need Dev Review
4 participants