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

Fix path to crud in resource config in documentation #17575

Merged
merged 1 commit into from
Dec 17, 2024

Conversation

JanPalen
Copy link
Contributor

@JanPalen JanPalen commented Dec 16, 2024

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

It is just an documentation fix.

Summary by CodeRabbit

  • Documentation

    • Updated guide for adding a custom Supplier entity to Sylius, including step-by-step instructions and configuration details.
  • New Features

    • Introduced a new Supplier entity and its corresponding repository.
    • Registered the Supplier entity as a resource in the system.
    • Updated routing for supplier administration in the admin panel.

@JanPalen JanPalen requested review from a team as code owners December 16, 2024 13:26
@probot-autolabeler probot-autolabeler bot added Documentation Documentation related issues and PRs - requests, fixes, proposals. Maintenance CI configurations, READMEs, releases, etc. labels Dec 16, 2024
Copy link

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request introduces a comprehensive guide for adding a custom Supplier entity to Sylius. The documentation provides a detailed, step-by-step process for creating a new entity, including generating the entity using Symfony's SymfonyMakerBundle, implementing the ResourceInterface, and configuring the entity in Sylius. The changes cover entity creation, repository setup, resource registration, routing modifications, and admin menu integration for managing suppliers.

Changes

File Change Summary
docs/the-customization-guide/customizing-models/how-to-add-a-custom-model.md Updated guide for adding a custom Supplier entity with detailed implementation steps
src/Entity/Supplier.php New entity implementation with ResourceInterface
src/Repository/SupplierRepository.php New repository extending EntityRepository
config/packages/sylius_resource.yaml Added resource registration for app.supplier
config/routes.yaml Modified routing for supplier admin with updated template path

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Maker as SymfonyMakerBundle
    participant Entity as Supplier Entity
    participant Repo as SupplierRepository
    participant Config as Sylius Configuration
    participant Admin as Admin Panel

    Dev->>Maker: Generate Supplier Entity
    Maker-->>Entity: Create entity class
    Dev->>Entity: Implement ResourceInterface
    Dev->>Repo: Create repository
    Dev->>Config: Register resource in sylius_resource.yaml
    Dev->>Config: Update routes
    Dev->>Admin: Add to admin menu
    Admin->>Entity: Manage suppliers
Loading

Poem

🐰 A Supplier's Tale, Hop by Hop

In Sylius' garden, a new seed we'll drop
With maker and config, our entity takes flight
A repository dancing in code's pure delight
From entity to admin, a rabbit's sweet dream
Custom models now flow like a magical stream! 🌱


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e6490f1 and 18d6dcb.

📒 Files selected for processing (1)
  • docs/the-customization-guide/customizing-models/how-to-add-a-custom-model.md (1 hunks)
🔇 Additional comments (1)
docs/the-customization-guide/customizing-models/how-to-add-a-custom-model.md (1)

163-163: Verify the updated template path.

The path change from @SyliusAdmin\Crud to @SyliusAdmin\shared\crud appears to be correct, but let's verify this is consistent with Sylius's current structure.

✅ Verification successful

Template path update is correct

The verification confirms that @SyliusAdmin\shared\crud is the correct path. The directory structure shows that CRUD templates are indeed located at ./src/Sylius/Bundle/AdminBundle/templates/shared/crud, which matches the updated template path in the documentation.

Key findings:

  • The CRUD templates exist at templates/shared/crud within the AdminBundle
  • The path follows Sylius's current template organization structure
  • Common CRUD operations (create, update, index, show) are present in this directory
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and usage of the new template path in Sylius

# Search for other occurrences of the new template path pattern
echo "Searching for other usages of the new template path..."
rg "@SyliusAdmin\\\\shared\\\\crud" --type yaml

# Search for the old template path to ensure we're not missing any other instances
echo "Checking for any remaining instances of the old template path..."
rg "@SyliusAdmin\\\\Crud" --type yaml

Length of output: 341


Script:

#!/bin/bash
# Let's try different search patterns and explore the template structure

# Search for template paths in yaml files with simpler patterns
echo "Searching for SyliusAdmin template paths..."
rg -i "syliusadmin.*template" --type yaml

# Search for crud-related template configurations
echo "Searching for crud-related template configurations..."
rg -i "crud.*template" --type yaml

# Look for any template configurations in config files
echo "Searching in config files..."
fd -e yaml -e yml -e xml config --exec grep -i "template" {} \;

# Check if there are any twig templates in the expected location
echo "Checking for twig templates..."
fd -e twig . --exec dirname {} \; | sort -u | grep -i "admin"

Length of output: 25947


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.

Copy link

github-actions bot commented Dec 16, 2024

Bunnyshell Preview Environment deleted

Available commands:

  • /bns:deploy to redeploy the environment

@mpysiak mpysiak merged commit 46dd5bc into Sylius:2.0 Dec 17, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals. Maintenance CI configurations, READMEs, releases, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants