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] Fix Modal/Portal reference docs #2450

Merged
merged 2 commits into from
Jun 2, 2020

Conversation

jcalcaben
Copy link
Contributor

Description

This PR fixes the reference doc generation for the Modal component, which has been renamed to Portal.

Related Issue

Closes PWA-641

Acceptance

any developer

Verification Stakeholders

any developer

Specification

Verification Steps

  1. Navigate to the pwa-devdocs directory: cd pwa-devdocs
  2. Build the preview site yarn develop
  3. Verify build succeeds without any errors
  4. Use the top nav to navigate to the Venia UI API section
  5. Verify Portal topic is listed on the left nav and points to the correct topic
  6. Verify Modal topic is not listed on the left nav

Screenshots / Screen Captures (if appropriate)

Checklist

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

@jcalcaben jcalcaben added pkg:pwa-devdocs documentation This pertains to documentation. docs documentation labels Jun 2, 2020
@m2-community-project m2-community-project bot added this to Ready for Review in Pull Request Progress Jun 2, 2020
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Jun 2, 2020

Messages
📖

Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.

📖 DangerCI Failures related to missing labels/description/linked issues/etc will persist until the next push or next nightly build run (assuming they are fixed).
📖

Associated JIRA tickets: PWA-641.

Generated by 🚫 dangerJS against 7f261c1

@devops-pwa-codebuild
Copy link
Collaborator

devops-pwa-codebuild commented Jun 2, 2020

Performance Test Results

The following fails have been reported by WebpageTest. These numbers indicates a possible performance issue with the PR which requires further manual testing to validate.

https://pr-2450.pwa-venia.com : LH Performance Expected 0.85 Actual 0.55, LH Best Practices Expected 1 Actual 0.92
https://pr-2450.pwa-venia.com/venia-tops.html : LH Performance Expected 0.75 Actual 0.33, LH Best Practices Expected 1 Actual 0.92
https://pr-2450.pwa-venia.com/valeria-two-layer-tank.html : LH Performance Expected 0.8 Actual 0.5, LH Accessibility Expected 0.9 Actual 0.89, LH Best Practices Expected 1 Actual 0.92

jimbo
jimbo previously approved these changes Jun 2, 2020
Copy link
Contributor

@jimbo jimbo left a comment

Choose a reason for hiding this comment

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

@jcalcaben Thanks for catching this. 👍

@m2-community-project m2-community-project bot moved this from Ready for Review to Reviewer Approved in Pull Request Progress Jun 2, 2020
@jimbo jimbo added version: Patch This changeset includes backwards compatible bug fixes. version: Minor This changeset includes functionality added in a backwards compatible manner. and removed version: Patch This changeset includes backwards compatible bug fixes. labels Jun 2, 2020
@tjwiebell tjwiebell force-pushed the jimothy/pwa-641_fix-portal-reference-docs branch from 91a7714 to 48f04a2 Compare June 2, 2020 21:38
Copy link
Contributor

@tjwiebell tjwiebell left a comment

Choose a reason for hiding this comment

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

Re-approve after force push fun time 🎉

@dpatil-magento
Copy link
Contributor

Verification steps look good.

@dpatil-magento dpatil-magento merged commit 756b913 into develop Jun 2, 2020
@dpatil-magento dpatil-magento deleted the jimothy/pwa-641_fix-portal-reference-docs branch June 2, 2020 22:38
@m2-community-project m2-community-project bot moved this from Reviewer Approved to Done in Pull Request Progress Jun 2, 2020
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: Minor This changeset includes functionality added in a backwards compatible manner.
Development

Successfully merging this pull request may close these issues.

None yet

6 participants