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.

Sign up for GitHub

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

Jump to bottom

[Doc] fix reference doc generator #2183

Merged
merged 7 commits into from
Feb 24, 2020
Merged

[Doc] fix reference doc generator #2183

merged 7 commits into from
Feb 24, 2020

Conversation

jcalcaben
Copy link
Contributor

Description

This PR fixes a bug in the reference doc generator caused by the migration of the Page Builder components into a separate package.

Related Issue

Closes PWA-391

Acceptance

@bdenham

Verification Stakeholders

@bdenham

Verification Steps

  1. navigate to the devdocs project
  2. Clean the project: npm run clean
  3. Build reference docs: npm run build:reference-doc-snippets
  4. Verify reference docs are generated with no errors under src/_includes/auto-generated
  5. Start the preview server: npm run start
  6. Verify project builds and starts with no errors

Screenshots / Screen Captures (if appropriate)

Checklist

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

@jcalcaben jcalcaben added bug Something isn't working pkg:pwa-devdocs documentation This pertains to documentation. version: Minor This changeset includes functionality added in a backwards compatible manner. docs documentation labels Feb 20, 2020
@m2-community-project m2-community-project bot added this to Ready for Review in Pull Request Progress Feb 20, 2020
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Feb 20, 2020 •
edited

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-391.

Generated by 🚫 dangerJS against c52b74d

bdenham
bdenham approved these changes Feb 20, 2020
View reviewed changes
Copy link
Contributor

@bdenham bdenham left a comment

Choose a reason for hiding this comment

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

Generated output looks good and builds as expected.

@m2-community-project m2-community-project bot moved this from Ready for Review to Reviewer Approved in Pull Request Progress Feb 24, 2020
@dpatil-magento dpatil-magento merged commit 6977e00 into develop Feb 24, 2020
@dpatil-magento dpatil-magento deleted the jimothy/pwa-391_fix-reference-doc-generator branch February 24, 2020 17:30
@m2-community-project m2-community-project bot moved this from Reviewer Approved to Done in Pull Request Progress Feb 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bdenham bdenham bdenham approved these changes

@supernova-at supernova-at supernova-at approved these changes

Assignees

@supernova-at supernova-at

Labels
bug Something isn't working docs documentation documentation This pertains to documentation. pkg:pwa-devdocs version: Minor This changeset includes functionality added in a backwards compatible manner.
Projects
Pull Request Progress
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@jcalcaben @PWAStudioBot @bdenham @supernova-at @dpatil-magento