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

[DO NOT MERGE] DS-867: Remove Image Task #2551

Closed
wants to merge 12 commits into from

Conversation

colbytcook
Copy link
Contributor

@colbytcook colbytcook commented Sep 30, 2022

Jira

https://pegadigitalit.atlassian.net/browse/DS-867

Summary

  • Refactored the Doc Site image folder and updated the documentation examples to reflect theses changes.
  • Removed Doc Site specific logic from the Image Component.
  • Replaced the Image Task with a simple Webpack copy task.

Details

Restructured the Doc Site image folder

  • Removed images/backgrounds/
  • Removed images/content/backgrounds/
  • Created images/content/academy/
  • Created images/content/best-of-content/
  • Created images/content/calculator/
  • Created images/content/contact/
  • Created images/content/heroes/
  • Created images/content/icons/
  • Created images/content/layout/
  • Removed images/content/logos/480x160
  • Created images/content/oclp/
  • Removed images/content/portraits
  • Created images/content/profiles/
  • Removed images/content/promos
  • Removed images/content/screenshots
  • Created images/content/user/
  • Removed images/docs
  • Removed images/heros
  • Removed images/logos
  • Created images/placeholders/backgrounds/
  • Removed images/shapes

Moving forward, we should be utilizing the couple options that are in the images/placeholders/ folder for most Doc Site images. There should be enough images variation to support most of what we need for test images. We can modify or add more moving forward.

The content folder should be utilized when we need to build Drupal specific mockups that requires that will be used to build out a design. These images are just for display purposes and should not be shipped to Drupal (Drupal has it's own image management system).

Updated the Documentation pages

  • Removed all unused images from the Doc Site image folder.
  • Updated existing images examples on the Doc Site to the placeholder images exmaples (if applicable).
  • Fixed the broken images on the archived Academy pages.

Updated the Image Build task

  • Removed Bolt doc site specific logic from the Image Component.
  • Removed the creation of the image.bolt.json manifest file (this is not needed anymore).
  • Removed the existing Image Task from the buiild, this will now be a simple webpack copy task.

How to test

  • Pull down the branch and test the yarn start, yarn build and yarn tests:js commands.
  • Click though the doc site to make sure no images are broken (you can quickly see this in a browsers dev tools).
    -- Note here, I did a very careful review of all the pages so I am fairly certain there are no broken images (no promises though) so i think we would be fine with just focusing on components/elements/pages that we know have a lot of images. For example, review the Background Component, Image Element and Academy pages among others.

Release notes

  • Refactored the Doc Site image folder
  • Updated the Doc Site pages images to new image folder paths
  • Removed the Image Task from the build

@colbytcook colbytcook changed the title DS-867: Remove Image Task [DO NOT MERGE] DS-867: Remove Image Task Sep 30, 2022
@colbytcook colbytcook temporarily deployed to feature/DS-86-Remove-Image-Task--branch-preview September 30, 2022 15:32 Inactive
@colbytcook colbytcook changed the title [DO NOT MERGE] DS-867: Remove Image Task DS-867: Remove Image Task Sep 30, 2022
@colbytcook colbytcook requested a deployment to feature/DS-86-Remove-Image-Task--2058c84--commit-preview September 30, 2022 20:15 In progress
@colbytcook colbytcook temporarily deployed to feature/DS-86-Remove-Image-Task--branch-preview September 30, 2022 20:21 Inactive
@colbytcook
Copy link
Contributor Author

colbytcook commented Oct 11, 2022

Closing, this work was merged in with #2556

@colbytcook colbytcook closed this Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants