commercetools-docs-kit icon indicating copy to clipboard operation
commercetools-docs-kit copied to clipboard

[release notes] Add new frontmatter for the indexer

Open timonrey opened this issue 1 year ago • 7 comments

closes https://github.com/commercetools/commercetools-docs/issues/4999

Smoke test example with multiple types: https://docskit-tt-add-frontmatter-for-release-note-indexer.commercetools.vercel.app/docs-smoke-test/releases

timonrey avatar May 22 '24 07:05 timonrey

🦋 Changeset detected

Latest commit: 3e93153f8f59ee57fdf7f7c4be50c4bfbb52ce85

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@commercetools-docs/gatsby-theme-docs Minor
@commercetools-website/api-docs-smoke-test Patch
@commercetools-website/docs-smoke-test Patch
@commercetools-website/documentation Patch
@commercetools-website/self-learning-smoke-test Patch
@commercetools-website/site-template Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

changeset-bot[bot] avatar May 22 '24 07:05 changeset-bot[bot]

🚚 Build Process Details

Preview URLs:

  • https://docskit-tt-add-frontmatter-for-release-note-indexer.commercetools.vercel.app (permalink to the last build of this branch)
  • https://docskit-sha-9a86bb91069208503de401e654d6b20e9ece8f58.commercetools.vercel.app (this commit)

github-actions[bot] avatar May 22 '24 07:05 github-actions[bot]

Hey @zbalek and @melindafekete

here is how the release note with the new frontmatters and types would look like Screenshot 2024-05-23 at 12 49 37 PM

or see it here https://docskit-tt-add-frontmatter-for-release-note-indexer.commercetools.vercel.app/docs-smoke-test/releases

are you happy with it? would you like to adjust something ?

for example you are displaying the types and topics. but not the new data (product and productArea) do you want to display them in the detail page ?

FFawzy avatar May 23 '24 10:05 FFawzy

@zbalek @melindafekete It's basically the same as before. Only that you can now define multiple types for the release note...and they will be displayed next to each other.

timonrey avatar May 23 '24 11:05 timonrey

Makes sense from my perspective, can you please check that the colors-types look as follows: image

Also, when it comes to marking the products/product areas on the areas, please see the designs: https://www.figma.com/design/GqhHFUcEaMxBXnMM9TXdaZ/%F0%9F%9F%A2-Feedback-Board?node-id=4743%3A15885&t=Dx4AbVlZ32DcFVtq-1

image

@timonrey @FFawzy @melindafekete

zbalek avatar May 23 '24 13:05 zbalek

@FFawzy I can include the deprecation type in this PR already, but I would handle the product areas separately if that's fine.

timonrey avatar May 23 '24 13:05 timonrey

Looks all good from my side. Thank you!

melindafekete avatar May 24 '24 12:05 melindafekete