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

DS-867 (Part 2 of 2) Restructure image folder, update docs pages #2555

Conversation

danielamorse
Copy link
Collaborator

Jira

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

Summary

  • Refactored the Doc Site image folder and updated the documentation examples to reflect theses changes.

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 its 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 examples (if applicable).
  • Fixed the broken images on the archived Academy pages.

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

@github-actions github-actions bot added the type: feature List this PR in the 'Features' section of the release notes. label Oct 4, 2022
@colbytcook colbytcook temporarily deployed to feature/DS-867-remove-image-task--image-updates--branch-preview October 4, 2022 19:03 Inactive
@colbytcook colbytcook temporarily deployed to feature/DS-867-remove-image-task--image-updates--branch-preview October 6, 2022 19:13 Inactive
Copy link
Collaborator

@adamszalapski adamszalapski left a comment

Choose a reason for hiding this comment

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

The docs-site/src/assets/images/placeholders/4x3-640.jpg and docs-site/src/assets/images/placeholders/4x3.jpg are the same but I think one of the should have 640 wide and the other should be much wider. Except this, all look good.

@colbytcook
Copy link
Contributor

@adamszalapski @danielamorse I removed the redundant docs-site/src/assets/images/placeholders/4x3-640.jpg image. it was not being used and it not needed. Nice catch Adam

@colbytcook colbytcook merged commit c98e237 into feature/DS-867-remove-image-task Oct 11, 2022
@colbytcook colbytcook deleted the feature/DS-867-remove-image-task--image-updates branch October 11, 2022 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature List this PR in the 'Features' section of the release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants