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.

Sign up for GitHub

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

Jump to bottom

Docs: Add real thumbnail img #2034

Merged
merged 11 commits into from
Jul 18, 2023
Merged

Docs: Add real thumbnail img #2034

merged 11 commits into from
Jul 18, 2023

Conversation

hannahiss
Copy link
Member

@hannahiss hannahiss commented May 12, 2023 •
edited
Loading

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

Related issues

Description

Replace current svg square yellow and blue with a thumbnail image

Motivation & Context

Doc enhancement

Types of change

  • Refactoring (non-breaking change)

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 responsive display

Development

  • My change follows the developer guide
  • I have added JavaScript unit tests to cover my changes
  • 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
  • Design review
  • A11y review

After the merge

@hannahiss hannahiss added docs Improvements or additions to documentation fix upcoming design review labels May 12, 2023
@github-actions
Copy link
Contributor

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 35.7%, saving 373 bytes.

Filename Before After Improvement Visual comparison
site/static/docs/5.3/assets/img/thumbnail.png 1.02 KB 673 bytes -35.7% View diff

61 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

@sonarcloud
Copy link

sonarcloud bot commented May 12, 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

@netlify
Copy link

netlify bot commented May 12, 2023

✅ Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 2a98d76
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/645e6019097a7600080b7ebb
😎 Deploy Preview https://deploy-preview-2034--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 settings.

@hannahiss hannahiss marked this pull request as ready for review May 12, 2023 15:52
@netlify
Copy link

netlify bot commented May 12, 2023 •
edited
Loading

✅ Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 86a0ab7
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/64b6cd2c5880ee00091904ec
😎 Deploy Preview https://deploy-preview-2034--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.

@MewenLeHo MewenLeHo self-requested a review May 22, 2023 12:09
MewenLeHo
MewenLeHo reviewed May 22, 2023
View reviewed changes
Copy link
Contributor

@MewenLeHo MewenLeHo left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Is this PR linked to a specific issue?
Could you also please check why the jobs are running endlessly? Fixed by Julien

MewenLeHo
MewenLeHo approved these changes May 23, 2023
View reviewed changes
Copy link
Contributor

@MewenLeHo MewenLeHo left a comment

Choose a reason for hiding this comment

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

Looks ok after discussion during daily meeting.

@hannahiss hannahiss self-assigned this Jun 9, 2023
@Franco-Riccitelli
Copy link

The thumbnail looks good. No issues.

@julien-deramond julien-deramond self-requested a review July 13, 2023 11:21
julien-deramond
julien-deramond approved these changes Jul 13, 2023
View reviewed changes
Copy link
Member

@julien-deramond julien-deramond left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM with the following suggested commit 5050278 containing:

  • Add "or PNG" in both paragraphs to show this new possibility
  • "Compress" elements to 1 line to avoid having whitespaces handling the spacing between the icons and the text, preferring the .me-1 spacing utility

Note: it'll need to be re-worked with the dark mode to switch the PNG or to change the PNG to a SVG version

@julien-deramond julien-deramond mentioned this pull request Jul 13, 2023
Closed
louismaximepiton
louismaximepiton reviewed Jul 18, 2023
View reviewed changes
site/content/docs/5.3/content/tables.md Outdated
<svg xmlns="http://www.w3.org/2000/svg" width="1.875rem" height="1.875rem" viewBox="0 0 30 30" role="img" aria-labelledby="svg1" class="me-2">
<title id="svg1">Document</title>
<use xlink:href="/docs/{{< param docs_version >}}/assets/img/boosted-sprite.svg#document">
</use>
Copy link
Member

Choose a reason for hiding this comment

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

Should be one line above

Copy link
Member

Choose a reason for hiding this comment

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

Good catch! Fixed in 3ce373a. I let you approve the PR if it's good for you so that it can land in the v5.3.0.

@sonarcloud
Copy link

sonarcloud bot commented Jul 18, 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 4a46f09 into main Jul 18, 2023
15 checks passed
@julien-deramond julien-deramond deleted the his-tables-thumbnail-img branch July 18, 2023 17:42
@julien-deramond julien-deramond mentioned this pull request Jul 18, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julien-deramond julien-deramond julien-deramond approved these changes

@louismaximepiton louismaximepiton louismaximepiton approved these changes

@MewenLeHo MewenLeHo MewenLeHo approved these changes

Assignees

@hannahiss hannahiss

Labels
docs Improvements or additions to documentation fix passed design review
Projects
🟣 [Orange-Boosted-Bootstrap] PRs Board
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@hannahiss @Franco-Riccitelli @julien-deramond @louismaximepiton @MewenLeHo