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

docs: revise buildpack target docs #2598

Merged
merged 1 commit into from Aug 3, 2020
Merged

docs: revise buildpack target docs #2598

merged 1 commit into from Aug 3, 2020

Conversation

zetlen
Copy link
Contributor

@zetlen zetlen commented Aug 3, 2020

Description

  • Update wording of buildpack target docs
  • Add more detail to the format of TransformRequest (more examples necessary!)
  • Fix the doc formatting of the new transformUpward target recently merged

Related Issue

Closes #ISSUE_NUMBER.

Acceptance

Verification Stakeholders

Specification

Verification Steps

  1. Go to the FOO page.
  2. Verify the BAR shows up.
  3. Make sure BAZ does a thing.

Screenshots / Screen Captures (if appropriate)

Checklist

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

@m2-community-project m2-community-project bot added this to Ready for Review in Pull Request Progress Aug 3, 2020
@PWAStudioBot
Copy link
Contributor

Fails
🚫 Missing information in PR. Please fill out the "Verification Steps" section.
🚫

No linked issue found. Please link a relevant open issue by adding the text "closes #<issue_number>" or "closes JIRA-<issue_number>" in your PR.
🚫 A version label is required. A maintainer must add one.
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).

If your PR is missing information, check against the original template here. At a minimum you must have the section headers from the template and provide some information in each section.

Generated by 🚫 dangerJS against b8149be

@devops-pwa-codebuild
Copy link
Collaborator

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-2598.pwa-venia.com : LH Performance Expected 0.85 Actual 0.33, LH Accessibility Expected 1 Actual 0.97, LH Best Practices Expected 1 Actual 0.92, WPT Cache Expected 90 Actual 39.333333333333
https://pr-2598.pwa-venia.com/venia-tops.html : LH Performance Expected 0.75 Actual 0.35, LH Best Practices Expected 1 Actual 0.92
https://pr-2598.pwa-venia.com/valeria-two-layer-tank.html : LH Performance Expected 0.8 Actual 0.41, LH Accessibility Expected 0.9 Actual 0.89, LH Best Practices Expected 1 Actual 0.92, WPT Cache Expected 65 Actual 50

@m2-community-project m2-community-project bot moved this from Ready for Review to Reviewer Approved in Pull Request Progress Aug 3, 2020
@jcalcaben jcalcaben merged commit c649817 into jimothy/buildpack-ref-docs Aug 3, 2020
@m2-community-project m2-community-project bot moved this from Reviewer Approved to Done in Pull Request Progress Aug 3, 2020
dpatil-magento added a commit that referenced this pull request Aug 4, 2020
@jcalcaben @dpatil-magento
[Doc] buildpack ref docs (#2508)
8fc82a3 
* Add buildpack configuration file to reference doc generator script

* Add topic for buildpack target ref docs

* Add module transform config ref docs and add to nav

* Revise js docs

* Add other reference topics

* Add initial files for the new ref topics

* Revise jsdocs for BuildBus and TargetProvider

* Revise JSDocs for the mapHooksToTarget file

* Revise JSDocs on the Target file

* Revise JSDocs in TargetProvider

* Minor fixes

* Apply suggestions from code review

Co-authored-by: James Zetlen <jzetlen@adobe.com>

* Revise JSDoc based on feedback

* Apply suggestions from code review

Co-authored-by: James Zetlen <jzetlen@adobe.com>

* [Doc] Suggested additions to buildpack ref docs (#2575)

* docs: elaborate on envVarDefinitions API

* Apply suggestions from code review

Co-authored-by: James Zetlen <jzetlen@adobe.com>

* Update pwa-devdocs/src/pwa-buildpack/reference/environment-variables/index.md

Co-authored-by: James Calcaben <jcalcaben@users.noreply.github.com>

* Update pwa-devdocs/src/pwa-buildpack/reference/environment-variables/index.md

Co-authored-by: James Calcaben <jcalcaben@users.noreply.github.com>

* docs: elaborate on envVarDefinitions API

Co-authored-by: James Calcaben <jcalcaben@users.noreply.github.com>

* Make changes based on feedback and removed 'in develop' notice

* Revise new environment variables topic

* [DOC] Suggested reorg of Buildpack reference doc content (#2579)

* bluh

* docs: reorg buildpack ref path

* Fix links in doc blocks

* doc: fix typo in Target docblock

* docs: revise buildpack devdocs (#2598)

* Fix links

Co-authored-by: James Zetlen <jzetlen@adobe.com>
Co-authored-by: Devagouda <40405790+dpatil-magento@users.noreply.github.com>
@sirugh sirugh deleted the zetlen/buildpack-ref-update-2 branch April 26, 2021 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jcalcaben jcalcaben jcalcaben approved these changes

Assignees

@jcalcaben jcalcaben

Labels
pkg:pwa-buildpack
Projects
Pull Request Progress
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@zetlen @PWAStudioBot @devops-pwa-codebuild @jcalcaben