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

doc: Reduce size of some svgs #19769

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Conversation

umapraseeda
Copy link
Contributor

@umapraseeda umapraseeda commented Jan 7, 2025

NCSDK-22369
NCSDK-22370
To preserve quality and to have reduced sizes (to meet CI compliance image size requirements), some of the SVGs are now converted into webp format.

@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 7, 2025
@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publish GitHub Action.

@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jan 7, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 3

Inputs:

Sources:

sdk-nrf: PR head: 6a82f6e3dd8e9e72786d3e7748f4a67ef6222c4d

more details

sdk-nrf:

PR head: 6a82f6e3dd8e9e72786d3e7748f4a67ef6222c4d
merge base: 3b735729736aee144dd82b201d897217e3c90eb7
target head (main): 3b735729736aee144dd82b201d897217e3c90eb7
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (17)
doc
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── device_guides
│  │  │  │  ├── thingy91
│  │  │  │  │  ├── images
│  │  │  │  │  │  ├── programmer_thingy91_connect_dk_swd_vddio.svg
│  │  │  │  │  │  ├── programmer_thingy91_connect_dk_swd_vddio.webp
│  │  │  │  │  │  ├── thingy91_sw1_sw3.svg
│  │  │  │  │  │  ├── thingy91_sw1_sw3.webp
│  │  │  │  │  │  ├── thingy91_sw1_sw4.svg
│  │  │  │  │  │  │ thingy91_sw1_sw4.webp
│  │  │  │  │  │ thingy91_updating_fw_programmer.rst
│  │  ├── gsg_guides
│  │  │  ├── images
│  │  │  │  ├── thingy53_nrf5340_dk.svg
│  │  │  │  ├── thingy53_nrf5340_dk.webp
│  │  │  │  ├── thingy53_sw1_sw2.svg
│  │  │  │  ├── thingy53_sw1_sw2.webp
│  │  │  │  ├── thingy53_sw1_usb.svg
│  │  │  │  ├── thingy53_sw1_usb.webp
│  │  │  │  ├── thingy91_insert_sim.svg
│  │  │  │  │ thingy91_insert_sim.webp
│  │  │  ├── thingy53_gs.rst
│  │  │  │ thingy91_gsg.rst

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_mosh
    • test-fw-nrfconnect-nrf-iot_nrf_provisioning
    • test-fw-nrfconnect-nrf-iot_positioning
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-fw-nrfconnect-zigbee
    • test-low-level
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-sidewalk
    • test-sdk-wifi
    • test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

@umapraseeda umapraseeda requested a review from gmarull January 9, 2025 07:54
@umapraseeda umapraseeda marked this pull request as ready for review January 9, 2025 07:55
@umapraseeda umapraseeda requested review from a team as code owners January 9, 2025 07:55
@umapraseeda umapraseeda requested a review from divipillai January 9, 2025 07:55
Copy link
Member

@gmarull gmarull left a comment

Choose a reason for hiding this comment

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

are we ok switching from SVG to webp (binary, non-scalable) format? What is the size reduction?

@umapraseeda
Copy link
Contributor Author

are we ok switching from SVG to webp (binary, non-scalable) format? What is the size reduction?

These images were originally hardware drawings generated using AutoCAD and they failed CI (whenever edits are made to the RSTs containing the images) because of image size > 250kb. Although @mirjaku tried reducing their sizes, it could not be made below 250 kb. Now with this webp format (as per your suggestion in the JIRA NCSDK-22370), these images can be made lesser in size (<250 kb) with the same quality.

NCSDK-22369
NCSDK-22370
To preserve quality and to have reduced sizes, some of the SVGs
are now converted into webp format.

Signed-off-by: Uma Praseeda <[email protected]>
@rlubos rlubos merged commit 9f8c7a4 into nrfconnect:main Jan 10, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants