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

Add callout Payment App Dev Guide #675

Merged
merged 2 commits into from
Sep 8, 2023

Conversation

ricardoaerobr
Copy link
Collaborator

Types of changes

  • New content (guides, endpoints, app documentation)
  • Improvement (make a documentation even better)
  • Fix (fix a documentation error)
  • Spelling and grammar accuracy (self-explanatory)

PR created to add a callout to the Payment App Dev Guide (EDU-10704).

@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2023

Preview Links

Open this URL to set up the portal with this branch changes.

You can now access the edited pages with the following URLs:

@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2023

Navigation Preview Link

No changes detected in the navigation.json file

Copy link
Collaborator

@karenkrieger karenkrieger left a comment

Choose a reason for hiding this comment

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

Ajustar os alertas do bot

3. Open the `manifest.json` file and update its content according to your scenario. If you need more information about the required fields, access our [Manifest documentation](https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest). The value set in the `name` field will be the unique identifier for this app and must be the exact name that corresponds to the response of your connector (`appname` property of `paymentAppData` field in the response body of the Create Payment endpoint). The `billingOptions` field is also required and set with the property `type` as `free`. More information about the `billingOptions` field can be found in the [Billing Options article](https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options).

4. After finishing the update, open the `pages/pages.json` file and replace `example-payment-auth-app` with the app `name` set in `manifest.json`. The `pages.json` file is responsible for creating the routes for your application. So it is necessary to make this configuration for the VTEX system to find and display the app at checkout. Also, the `"component"` field having the `"index"` value indicates that the `index.js` file in the `react` folder is the file with the component that will be instantiated at checkout.
Copy link
Contributor

Choose a reason for hiding this comment

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

[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 3; Actual: 4; Style: 1/2/3]

Copy link
Collaborator

@karenkrieger karenkrieger left a comment

Choose a reason for hiding this comment

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

LGTM

@ricardoaerobr ricardoaerobr merged commit 028697e into main Sep 8, 2023
4 checks passed
@ricardoaerobr ricardoaerobr deleted the Add-callout-Payment-App-Dev-guide branch September 8, 2023 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants