Skip to content

Update payment docs#17687

Merged
GSadee merged 1 commit intoSylius:2.0from
JanPalen:integrate-a-payment-gateway-docs-update
Feb 25, 2025
Merged

Update payment docs#17687
GSadee merged 1 commit intoSylius:2.0from
JanPalen:integrate-a-payment-gateway-docs-update

Conversation

@JanPalen
Copy link
Copy Markdown
Contributor

@JanPalen JanPalen commented Feb 21, 2025 •
edited by coderabbitai bot
Loading

Q A
Branch? 2.0
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Related tickets
License MIT

Currently, there is no information about data encryption in the payment configuration.
I have added documentation about the required encryption key.

Summary by CodeRabbit

  • Documentation
    • Updated the payment integration guide with a new note on generating a valid encryption key.
    • Provided clear instructions for running the command to secure payment configuration data.
    • Highlighted that sensitive information like API keys and payment credentials is encrypted to ensure security compliance.

@JanPalen JanPalen requested review from a team as code owners February 21, 2025 15:40
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 21, 2025 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The documentation has been updated to include a new note section in the payment gateway integration guide. This section instructs users on creating a new payment configuration in Sylius by generating an encryption key via the command bin/console sylius:payment:generate-key. It explains that Sylius encrypts sensitive configuration data (such as API keys and payment credentials) for enhanced security compliance.

Changes

File(s) Summary of Changes
docs/the-customization-guide/.../how-to-integrate-a-payment-gateway-as-a-plugin.md Added a note section to instruct on generating an encryption key and explained how Sylius encrypts sensitive payment configuration data.

Suggested labels

Documentation, Maintenance

Suggested reviewers

  • GSadee

Poem

Oh, hop along in rhythmic delight,
A note has been added, shining so bright.
Keys are generated with a click and cheer,
Encrypting secrets, keeping them clear.
I'm a bunny, joyful in rhyme,
Celebrating docs perfected in time! 🐰
Hop on, enjoy the secure design!

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 21, 2025 •
edited
Loading

✅ Preview Environment deployed on Bunnyshell

Component Endpoints
mailhog https://mailhog-xwa5ni.bunnyenv.com/
php https://store-xwa5ni.bunnyenv.com/

See: Environment Details | Pipeline Logs

Available commands:

  • 🔴 /bns:stop to stop the environment
  • 🚀 /bns:deploy to redeploy the environment
  • ❌ /bns:delete to remove the environment

Prometee
Prometee previously approved these changes Feb 21, 2025
View reviewed changes
NoResponseMate
NoResponseMate previously approved these changes Feb 25, 2025
View reviewed changes
@GSadee GSadee added the Documentation Documentation related issues and PRs - requests, fixes, proposals. label Feb 25, 2025
@GSadee GSadee changed the base branch from 2.1 to 2.0 February 25, 2025 12:44
@GSadee GSadee dismissed stale reviews from NoResponseMate, Prometee, and christopherhero February 25, 2025 12:44

The base branch was changed.

@GSadee GSadee changed the base branch from 2.0 to 2.1 February 25, 2025 12:47
@GSadee GSadee changed the base branch from 2.1 to 2.0 February 25, 2025 12:47
@GSadee
Copy link
Copy Markdown
Member

GSadee commented Feb 25, 2025

The base of this pull-request was changed, you need fetch and reset your local branch
if you want to add new commits to this pull request. Reset before you pull, else commits
may become messed-up.

Unless you added new commits (to this branch) locally that you did not push yet,
execute git fetch origin && git reset "integrate-a-payment-gateway-docs-update" to update your local branch.

Feel free to ask for assistance when you get stuck 👍

@GSadee GSadee force-pushed the integrate-a-payment-gateway-docs-update branch from 77f8790 to 52f38f2 Compare February 25, 2025 12:47
@probot-autolabeler probot-autolabeler bot added the Maintenance CI configurations, READMEs, releases, etc. label Feb 25, 2025
@GSadee GSadee merged commit 06e2eef into Sylius:2.0 Feb 25, 2025
4 checks passed
@GSadee
Copy link
Copy Markdown
Member

GSadee commented Feb 25, 2025

Thank you @JanPalen! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GSadee GSadee GSadee approved these changes

@Prometee Prometee Prometee left review comments

@NoResponseMate NoResponseMate NoResponseMate left review comments

@christopherhero christopherhero christopherhero left review comments

Assignees

No one assigned

Labels

Documentation Documentation related issues and PRs - requests, fixes, proposals. Maintenance CI configurations, READMEs, releases, etc.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@JanPalen @GSadee @Prometee @NoResponseMate @christopherhero