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: enhance doc for Solaris icons #2075

Merged
merged 53 commits into from
Feb 23, 2024
Merged

Conversation

hannahiss
Copy link
Member

@hannahiss hannahiss commented Jun 8, 2023

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

Related issues

Has been splitted from #1929
Should be merged after #2030 in order to have a complete functionality for SVG sprite icons with text color utilities and a good documentation
Should be merged after #2240 in order to have new warning icon everywhere

Description

In icons documentation (extend > icons):

  • rearrange chapters: Solaris global chapter is not needed since we only talk about Solaris icons
  • remove "Boosted mod: link to Orange Accessibility Guideline" (since it is a Boosted documentation only)
  • use text colors utilities that have been reintroduced by Reintroduce all text color utilities #2030
  • add warning icon example on white since it is now usable after Alerts: Change warning icon #2240
  • update whole documentation
  • remove icomoon mention (not needed anymore with Solaris icons finder)

In Tooltip component (components > tooltips):

  • use text color utility .text-info for tooltip icon and remove color from Boosted sprite

In tables (content > tables):

  • change the way to make icons accessible to match icons documentation

Everywhere:

Change icon boosted-cross.svg with the one from Icons finder

Remove icons doc from utilities/colors and point to icons documentation instead

Motivation & Context

  • After Solaris icons finder was released:
    • change documentation to match with Solaris icons finder docs
    • change icons with the ones from finder (viewbox)
    • change boosted-cross.svg with the good icon
  • After reintroducing text colors utilities, they can be used for icons, and we have to document it
  • Add boosted-warning.svg to allow developers to use bi-colored warning icon

Types of change

  • New feature (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
  • (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)

  • (NA) 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
  • Design review
  • A11y review

After the merge

@netlify
Copy link

netlify bot commented Jun 8, 2023

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 5c4875c
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/65d869c5d7ba5a0008bd2221
😎 Deploy Preview https://deploy-preview-2075--boosted.netlify.app/docs/5.3/migration
📱 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.

@hannahiss hannahiss added v5 docs Improvements or additions to documentation on hold labels Jun 8, 2023
@hannahiss

This comment was marked as resolved.

@sonarcloud
Copy link

sonarcloud bot commented Jun 8, 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

@hannahiss hannahiss self-assigned this Jun 9, 2023
@julien-deramond

This comment was marked as resolved.

@julien-deramond
Copy link
Member

julien-deramond commented Jul 13, 2023

FYI, tackled one of the sub-tasks to save you some time via be5e2e0. If the rest is too long to do, or not prioritized, this modification could be extracted from this PR to be merged right away.

@sonarcloud
Copy link

sonarcloud bot commented Jul 13, 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

@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 @hannahiss!
Some minor suggestions, modifications and questions, and we'll be good to go!

site/assets/scss/_component-examples.scss Outdated Show resolved Hide resolved
site/assets/scss/_component-examples.scss Outdated Show resolved Hide resolved
</symbol>
<symbol fill="currentColor" viewBox="0 0 24 24" id="danger">
<path d="m21.832 17.617-7.886-13.5a2.256 2.256 0 0 0-3.892 0L2.186 17.583v.002l-.02.032h.001A2.248 2.248 0 0 0 4.113 21h15.773a2.25 2.25 0 0 0 1.946-3.383Zm-6.88-.714a.823.823 0 0 1-1.163 0l-1.93-1.932-1.93 1.932a.823.823 0 0 1-1.174-1.155l.01-.01 1.93-1.93-1.861-1.863a.823.823 0 0 1 1.163-1.164l1.862 1.862 1.861-1.862a.823.823 0 0 1 1.174 1.153l-.01.011-1.862 1.862 1.93 1.931a.824.824 0 0 1 0 1.165Z"/>
<symbol fill="currentColor" viewBox="0 0 1000 1000" id="error-severe">
Copy link
Member

Choose a reason for hiding this comment

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

I can see a lot of modifications here to have viewBox="0 0 1000 1000" versions. Don't we need to update the warning, success, error, etc. icons in _variables.scss? (e.g. $warning-icon-filled etc.)

Copy link
Member Author

Choose a reason for hiding this comment

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

Discussed together: not to be modified for now because the risk is too big to make a mistake and the difference is tiny...
The differences between Boosted and designs (V6 kit) should be tracked in an issue though (in particular paddings that do not include borders)

Copy link
Member

Choose a reason for hiding this comment

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

Yep, let's create a dedicated issue after having merged this PR to tackle it for the next release

site/content/docs/5.3/utilities/colors.md Outdated Show resolved Hide resolved
site/content/docs/5.3/utilities/colors.md Outdated Show resolved Hide resolved
site/content/docs/5.3/extend/icons.md Outdated Show resolved Hide resolved
site/content/docs/5.3/extend/icons.md Outdated Show resolved Hide resolved
site/content/docs/5.3/extend/icons.md Outdated Show resolved Hide resolved
site/content/docs/5.3/extend/icons.md Outdated Show resolved Hide resolved
site/content/docs/5.3/extend/icons.md Outdated Show resolved Hide resolved
hannahiss and others added 8 commits February 22, 2024 13:54
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
@julien-deramond julien-deramond merged commit 1ec6baf into main Feb 23, 2024
12 checks passed
@julien-deramond julien-deramond deleted the main-his-solaris-icons-doc branch February 23, 2024 09:50
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 v5
Projects
Development

Successfully merging this pull request may close these issues.

3 participants