Contributors: move to sites, change context of use #2459
Conversation
|
Pre-approved upon successful review. |
There was a problem hiding this comment.
Todo:
- Centralize sample inside the contributor component.
- (Optional) remove the "gc-" prefix in the file/folder name for the contributor component
- Update the contributor component documentation to add more emphasis on the breaking change + migration instruction.
- Page details - move demoted pattern in demoted folder
- For "contributor" component, make it a minor version for now (v1.1) because both are still ok, but identify the version 1.0 as demoted. We will increase the major version when we will switch the v1.0 from "demoted" into "deprecated" state.
This change is:
- Minor change for contributor component - Add new pattern where located in the page details section
- Minor change for page details component - Add new pattern that include the contributor component
- Minor change for Topic template - Add new pattern that include the new page details with the contributor component
- Minor change for the "Topic" template - Add new pattern that implement page-details v 3.3 where the contributor component are in the page-details section
- We will perform a major change to those component, when we will switch them from "demoted" into "deprecated" at our next major release
There was a problem hiding this comment.
Please move it in sites/gc-contributors/samples/gc-contributors.html
It is specific to gc-contributor and we need to keep all component specific item in the same base folder
And please remove it here: _includes/components/gc-contributors/gc-contributors.html
| "_:implement_contributors", | ||
| "_:implement_contributors_gcweb" |
There was a problem hiding this comment.
We need an additional "implementation" for the migration instruction from v1 to v2.
Where it mention:
- Date of when this is applicable, use December 2024 like in the history.
- Describe the breaking change and mention there is an impact on page details component and link to it. Like require minimal version 3.3 of page details component.
| @@ -81,7 +86,7 @@ | |||
| "implementation": [ | |||
| { | |||
| "@id": "_:implement_contributors", | |||
| "iteration": "_:iteration_contributors_2", | |||
| "iteration": "_:iteration_contributors_3", | |||
There was a problem hiding this comment.
For this implementation, please be clear in the instruction this need to be added in the page details section and do require the implementation of page details v3.3 + a link if possible to page details docs.
| { | ||
| "@id": "_:iteration_contributors_3", | ||
| "name": "Contributors - Iteration 3", | ||
| "date": "2024-05", |
There was a problem hiding this comment.
| "date": "2024-05", | |
| "date": "2024-12", |
| "date": "2024-05", | ||
| "detectableBy": ".pagedetails .gc-contributors", | ||
| "breaking": [ | ||
| "Changed context of use in the page. The component should be located in the page details section above the date modified component." |
There was a problem hiding this comment.
| "Changed context of use in the page. The component should be located in the page details section above the date modified component." | |
| "Changed context of use in the page. The component must be located in the page details section above the date modified component." |
Note: It is not an optional location.
There was a problem hiding this comment.
Move to "demoted" and identify in the docs as "demoted"
There was a problem hiding this comment.
Move to "demoted" and identify in the docs as "demoted"
| @@ -17,7 +17,7 @@ | |||
| "modified": "2024-08-27", | |||
| "componentName": "topic", | |||
| "status": "stable", | |||
| "version": "2.1", | |||
| "version": "3.0", | |||
There was a problem hiding this comment.
Set a minor version for now (v2.2) as we do allow both pattern for now, but demote the version 2.1
There was a problem hiding this comment.
Need implementation with migration instruction from version 2.0 (demoted) to v2.1 (stable)
| @@ -194,7 +202,7 @@ | |||
| }, | |||
| { | |||
| "@id": "_:implement_topic_aem", | |||
| "iteration": "_:iteration_topic_3", | |||
| "iteration": "_:iteration_topic_4", | |||
There was a problem hiding this comment.
For this one, add an instruction note that mention about the "Contributor" component that are located in the "page details" configuration
Related to WET-505