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

[doc] Update usage of UI Component #1462

Merged

Conversation

jcalcaben
Copy link
Contributor

Description

Updates references to Peregrine as a "UI Component" library.

This PR also fixes linting issues in affected, published topics.

Related Issue

Closes #1396

Verification Steps

  1. Navigate to the pwa-devdocs directory
  2. Run linting on the affected, published topic (drafts are excluded from this check):
npm run lint src/peregrine/testing/storybook/index.md
npm run lint src/technologies/overview/index.md
npm run lint src/technologies/tools-libraries/index.md
  1. Verify no linting issues
  2. Build preview npm run develop
  3. Verify UI Component is listed as Peregrine Component in navigation and on front page box

Screenshots / Screen Captures (if appropriate)

n/a

Checklist:

  • I have updated the documentation accordingly, if necessary.
  • I have added tests to cover my changes, if necessary.

@jcalcaben jcalcaben added pkg:pwa-devdocs documentation This pertains to documentation. version: Patch This changeset includes backwards compatible bug fixes. docs documentation labels Jul 24, 2019
@vercel
Copy link

vercel bot commented Jul 24, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://venia-git-jimothy-gh-1396replace-ui-component-term-usage.magento-research1.now.sh

@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Jul 24, 2019

Messages
📖 We are currently working on automating the PR metadata checks. Until that time, you may see failures related to labels/description/linked issues/etc even if you have fixed the problem. Failures will persist until the next push (assuming they are fixed).

Generated by 🚫 dangerJS against b603aca

@supernova-at supernova-at self-assigned this Jul 25, 2019
Copy link
Contributor

@supernova-at supernova-at left a comment

Choose a reason for hiding this comment

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

Some minor change requests


Currently, the Peregrine package is the only project set up to use Storybook as a development and testing environment for its UI components.
Currently, the Peregrine package is the only project set up to use Storybook as a development and testing environment for its components.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not actually true, Venia has a storybook too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, I see. This topic needs a revision anyways. Will add it to the backlog.

@@ -136,5 +135,5 @@ This command starts the Storybook application that is accessed through the brows
http://localhost:9001/
```

[Storybook]: https://storybook.js.org/
[official Storybook documentation]: https://storybook.js.org/basics/introduction/
[storybook]: https://storybook.js.org/
Copy link
Contributor

Choose a reason for hiding this comment

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

Does it matter that the casing here doesn't match the link on line 5?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it does not matter in markdown, but one of my linting rules is that all link references be in all lowercase.

pwa-devdocs/src/technologies/overview/index.md Outdated Show resolved Hide resolved
Co-Authored-By: Andy Terranova <13182778+supernova-at@users.noreply.github.com>
@supernova-at supernova-at removed their assignment Jul 25, 2019
@dpatil-magento dpatil-magento merged commit fa7a2c0 into develop Jul 25, 2019
@dpatil-magento dpatil-magento deleted the jimothy/gh-1396_replace-ui-component-term-usage branch July 25, 2019 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation documentation This pertains to documentation. pkg:pwa-devdocs version: Patch This changeset includes backwards compatible bug fixes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[doc]: Audit docs for uses of the term UI Component
4 participants