Component library #516

aliceoq · 2023-10-26T14:25:10Z

What is the purpose of this pull request?

To use the components from the component library.

How should this be manually tested?

Open the preview and check if the following components are working in the same way as the current Developers Portal:

Sidebar
Search input
Search page
Feedback section + feedback modal
Documentation page (markdown renderer)
Table of Contents

More information on here.

Screenshots or example usage

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Requires change to documentation, which has been updated accordingly.

netlify · 2023-10-26T14:25:16Z

✅ Deploy Preview for elated-hoover-5c29bf ready!

Name	Link
🔨 Latest commit	`b14d2c2`
🔍 Latest deploy log	https://app.netlify.com/sites/elated-hoover-5c29bf/deploys/655b3b953604b90008888953
😎 Deploy Preview	https://deploy-preview-516--elated-hoover-5c29bf.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2023-10-26T14:29:43Z

A total of 6 tests failed!

API guides documentation page

2 failing tests:

Check if a random guide page, chosen using the sidebar, loads (/docs/guides)
try to click on any document contributor (/docs/guides)

Status of documentation pages

4 failing tests:

Checks page docs/guides/webservice-deprecated
Checks page docs/guides/webservice-deprecated
Checks page docs/guides/webservice-deprecated
Checks page docs/guides/webservice-deprecated

For more information, open the cypress action summary page.

github-actions · 2023-10-26T14:54:24Z

Performance Results

Page /

Complete results here

Page /docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions

Complete results here

Page /docs/guides/adding-telesales-impersonated-email-using-the-session-manager

Complete results here

Page /docs/api-reference/tracking

Complete results here

Page /docs/api-reference/tracking#post-/auth

Complete results here

Page /docs/api-reference/reviews-and-ratings-api

Complete results here

Page /docs/api-reference/reviews-and-ratings-api#get-/rating/-productId-

Complete results here

Page /docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository

Complete results here

Page /docs/guides/vtex-io-documentation-promoting-a-workspace-to-master

Complete results here

Page /docs/guides/google-one-tap-login

Complete results here

Page /docs/apps/vtex.store-form

Complete results here

Page /docs/guides/vtex-io-documentation-using-css-handles-for-store-customization

Complete results here

Page /docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io

Complete results here

Page /updates/release-notes/2023-07-06-search-api-teasers-field-deprecation

Complete results here

Page /updates/release-notes/images-non-active-dots-customization-css-handle

Complete results here

Overall Performance

carolinamenezes · 2023-11-10T20:15:10Z

Callouts não estão renderizando corretamente:

Comportamento do preview	Comportamento desejado

Atentar para o fato que temos comportamentos diferentes para os seguintes casos:

❗ This is a Danger callout.

⚠ This is a Warning callout.

✅ This is a Success callout.

ℹ️ This is an Info callout.

Sendo o callout do estilo ℹ️, o default

carolinamenezes · 2023-11-10T20:17:55Z

Estilos do mermaid foram motificados:

Estilo do preview	Estilo desejado

carolinamenezes · 2023-11-10T20:20:54Z

Estilos de código estão diferentes:

Estilo no preview	Estilo desejado

carolinamenezes · 2023-11-10T20:24:21Z

Placeholder da barra de pesquisa ficou descentralizado

Comportamento do preview	Comportamento desejado

carolinamenezes · 2023-11-10T20:31:11Z

O componente <Flex> era exportado e usado em algumas docs, mas acho que dá para resolver adaptando o componente de Card, sem precisar exportar o Flex:

Comportamento do preview	Comportamento desejado

carolinamenezes · 2023-11-10T20:38:22Z

Placeholder da pesquisa da sidebar não indica que a pesquisa serve apenas para o menu selecionado

Comportamento do preview	Comportamento desejado

ps.: tem um erro na versão (in in) em prod 😮

carolinamenezes

LGTM

RobsonOlv

LGTM 🚀

brunoamui

LGTM

aliceoq added the release-minor Minor version bump label Oct 26, 2023

github-actions bot approved these changes Oct 26, 2023

View reviewed changes

aliceoq requested a review from RobsonOlv October 26, 2023 16:25

aliceoq force-pushed the feat/sidebar-module branch from 2d03cab to cbb7905 Compare October 31, 2023 10:58

aliceoq marked this pull request as ready for review October 31, 2023 13:46

aliceoq marked this pull request as draft October 31, 2023 13:46

aliceoq force-pushed the feat/sidebar-module branch 2 times, most recently from 3585538 to 7bb2799 Compare November 8, 2023 21:13

aliceoq requested a review from brunoamui November 8, 2023 21:25

aliceoq force-pushed the feat/sidebar-module branch from 4c952a0 to 6b1b99d Compare November 9, 2023 00:41

aliceoq marked this pull request as ready for review November 9, 2023 11:17

aliceoq requested a review from carolinamenezes November 10, 2023 17:36

carolinamenezes approved these changes Nov 16, 2023

View reviewed changes

RobsonOlv approved these changes Nov 17, 2023

View reviewed changes

brunoamui approved these changes Nov 17, 2023

View reviewed changes

aliceoq added 6 commits November 20, 2023 07:49

chore: delete all sidebar related components

b03aeb3

refactor: use librarycontext

30eb652

refactor: use header from library

538f7c6

fix: use announcements as header props

f737c39

fix: use router to check if it is preview

09dc196

refactor: use was this helpful component from lib

b2baaea

aliceoq and others added 22 commits November 20, 2023 07:49

refactor: using search components from lib

d2300d3

chore: delete all search related components

39c1a76

fix: use library config

102bed3

fix: restore header

42fd828

feat: add component lib build file

d0cc0a3

feat: create alias for component lib filepath

b483d7b

chore: delete unused files

97f6ba3

chore: delete unused file

6a4923d

feat: use MarkdownRenderer and toc from library

204aaab

feat: get all build files

c32ba10

fix: add headingList as prop

4ceecea

chore: update components lib version

398ffd1

revert: remove lib build files from public

6fdcd4b

feat: add @vtexdocs/library dependency and update imports

e3114cf

fix: update prebuild script

4706ede

chore: update component lib version

d76dd55

chore: update yarn.lock

91af2c1

style: add components lib css

491657e

chore: delete mermaidInit file

2213fab

build: update components version

1ea5959

chore: update lock file

a3168d6

chore: update components lib version

b14d2c2

aliceoq force-pushed the feat/sidebar-module branch from ad01b6b to b14d2c2 Compare November 20, 2023 10:57

aliceoq merged commit a3b563d into main Nov 20, 2023
6 of 7 checks passed

aliceoq deleted the feat/sidebar-module branch November 20, 2023 11:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Component library #516

Component library #516

aliceoq commented Oct 26, 2023 •

edited

Loading

netlify bot commented Oct 26, 2023 •

edited

Loading

github-actions bot commented Oct 26, 2023 •

edited

Loading

github-actions bot commented Oct 26, 2023 •

edited

Loading

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023 •

edited

Loading

carolinamenezes left a comment

RobsonOlv left a comment

brunoamui left a comment

Component library #516

Component library #516

Conversation

aliceoq commented Oct 26, 2023 • edited Loading

What is the purpose of this pull request?

How should this be manually tested?

Screenshots or example usage

Types of changes

netlify bot commented Oct 26, 2023 • edited Loading

✅ Deploy Preview for elated-hoover-5c29bf ready!

github-actions bot commented Oct 26, 2023 • edited Loading

API guides documentation page

Status of documentation pages

github-actions bot commented Oct 26, 2023 • edited Loading

Performance Results

Overall Performance

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023

carolinamenezes commented Nov 10, 2023 • edited Loading

carolinamenezes left a comment

Choose a reason for hiding this comment

RobsonOlv left a comment

Choose a reason for hiding this comment

brunoamui left a comment

Choose a reason for hiding this comment

aliceoq commented Oct 26, 2023 •

edited

Loading

netlify bot commented Oct 26, 2023 •

edited

Loading

github-actions bot commented Oct 26, 2023 •

edited

Loading

github-actions bot commented Oct 26, 2023 •

edited

Loading

carolinamenezes commented Nov 10, 2023 •

edited

Loading