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

Removed metadata component #3275

Merged

Conversation

precious-onyenaucheya-ons
Copy link
Contributor

@precious-onyenaucheya-ons precious-onyenaucheya-ons commented Jul 23, 2024

What is the context of this PR?

Fixes ONSdigital/design-team#48
This PR removes the Metadata component from the DS project.

Breaking Change

  • Description of change: The onsMetadata component has been removed.

  • Reason for change: The component was removed as it has been replaced by the descriptionList component.

  • Migration steps:

    1. Locate all instances of onsMetadata in your codebase.
    2. You could update any instance of onsMetadata with onsDescriptionList.
    • Click for example:
         OLD
         {% from "components/onsMetadata/_macro.njk" import onsMetadata %}
      
         {{-
             onsMetadata({ ... })
         }}
      
         NEW
         {% from "components/description-list/_macro.njk" import onsDescriptionList %}
          
          {{
             onsDescriptionList({ ... })
          }}
      

How to review this PR

Check that all references to the metadata component has been removed

Checklist

This needs to be completed by the person raising the PR.

  • I have selected the correct Assignee
  • I have linked the correct Issue

Copy link

netlify bot commented Jul 23, 2024

Deploy Preview for ons-design-system-preview ready!

Name Link
🔨 Latest commit 2dfa946
🔍 Latest deploy log https://app.netlify.com/sites/ons-design-system-preview/deploys/66a269f7b19deb0008081c9a
😎 Deploy Preview https://deploy-preview-3275--ons-design-system-preview.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.

@precious-onyenaucheya-ons precious-onyenaucheya-ons added Enhancement Change of existing feature Breaking changes This PR contains at least one breaking change and removed Breaking changes This PR contains at least one breaking change Enhancement Change of existing feature labels Jul 23, 2024
@precious-onyenaucheya-ons precious-onyenaucheya-ons requested a review from a team July 23, 2024 12:00
@precious-onyenaucheya-ons precious-onyenaucheya-ons changed the title remove metadata component Removed metadata component Jul 23, 2024
@rmccar rmccar added the Do not merge Don't merge this PR until this label is removed label Jul 25, 2024
Copy link
Contributor

@alessioventuriniAND alessioventuriniAND left a comment

Choose a reason for hiding this comment

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

I would change the example listed in the body of the PR so that it looks like the below. No need to list all of the parameters as they are not changing, the only thing that is changing is the name of the component :

Click for example:
       OLD
       {% from "components/onsMetadata/_macro.njk" import onsMetadata %}

       {{-
           onsMetadata({ ... })
       }}

       NEW
       {% from "components/description-list/_macro.njk" import onsDescriptionList %}
        
        {{
           onsDescriptionList({ ... })
        }}

@precious-onyenaucheya-ons
Copy link
Contributor Author

I would change the example listed in the body of the PR so that it looks like the below. No need to list all of the parameters as they are not changing, the only thing that is changing is the name of the component :

Click for example:

       OLD
       {% from "components/onsMetadata/_macro.njk" import onsMetadata %}

       {{-
           onsMetadata({ ... })
       }}

       NEW
       {% from "components/description-list/_macro.njk" import onsDescriptionList %}
        
        {{
           onsDescriptionList({ ... })
        }}

done

@alessioventuriniAND alessioventuriniAND self-requested a review July 25, 2024 15:08
@MagdalenaLarge MagdalenaLarge mentioned this pull request Aug 1, 2024
7 tasks
@alessioventuriniAND alessioventuriniAND changed the base branch from main to major-release September 3, 2024 08:50
@alessioventuriniAND alessioventuriniAND added Tech improvements Tech debt, cleanup, code standardisation etc. and removed Do not merge Don't merge this PR until this label is removed labels Sep 5, 2024
@alessioventuriniAND alessioventuriniAND merged commit 239dd67 into major-release Sep 5, 2024
9 of 12 checks passed
@alessioventuriniAND alessioventuriniAND deleted the feature/48/remove-metadata-component branch September 5, 2024 10:58
This was referenced Sep 10, 2024
rmccar pushed a commit that referenced this pull request Oct 9, 2024
rmccar pushed a commit that referenced this pull request Oct 9, 2024
* Standardise setting heading level across components #3111

* Update param names to camel case naming standard #3188

* Renamed utility class from ons-grid--flex to ons-grid-flex #3268

* Removed metadata component #3275

* Remove call to action component and all references #3143

* Update parameter from UnreadLink to UnreadLinkUrl in Message component #3290

* Update parameter subject from text to object type in Message list component #3291

* Add option for additional logo in footer #3227

* Update parameter from link to text in Footer Component #3294

* Update parameter name from url to src in Image Component #3293

* Update parameter names from LogoImage and LogoURL to image and url a in header component #3292

* Update parameter name from url to linkUrl in feedback component #3295

* Rename summary component parameters #3224

* Refactor timeline macro for compatibility with Jinja2 templates #3180

* Update parameter names in document list component #3299

* Update param name settingsLinkTextURL to settingsLinkURL in Cookies Banner component #3300

* Update parameter names in card component #3303

* Update parameter from linkText to text in external link component #3304

* Update param name from title to text in section navigation component #3305

* Update parameter from linkText to videoLinkText in Video Component #3306

* Update parameter from manualLink to manualLinkUrl in Address Input component #3307

* Ensure list item custom attributes are always set on list item #3336

* Rename items summary param for compatibility with Jinja #3382

* Update DS components to ensure compatibility with Jinja #3380

* Rename html OGL Link param to current naming standard #3379

* Format migration guide #3377

* Introduction of new spacing grid #3285
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking changes This PR contains at least one breaking change Tech improvements Tech debt, cleanup, code standardisation etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TASK] Remove deprecated component - Metadata
4 participants