-
Notifications
You must be signed in to change notification settings - Fork 32
Quote Management Documentation #656
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
Open
bdenham
wants to merge
26
commits into
releases/b2b-nov-release
Choose a base branch
from
b2b-docs-quote-management-v2
base: releases/b2b-nov-release
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
7bb3131
feat: Add quote-management dropin documentation
bdenham 0138129
Update TableWrapper nowrap to [0,1] for all tables
bdenham 47e5b7b
Add missing parameter descriptions to ShippingAddressDisplay container
bdenham bd8c1be
Update container parameter descriptions to verb-first form
bdenham f942ae2
Update enrichment files: Sync parameter descriptions from documentation
bdenham d7870d6
Merge branch 'releases/b2b-nov-release' into b2b-docs-quote-managemenβ¦
bdenham 79f8c86
Merge branch 'releases/b2b-nov-release' of https://github.com/commercβ¦
bdenham 9c22b09
Merge branch 'b2b-docs-quote-management-v2' of https://github.com/comβ¦
bdenham 602be5a
chore: Restore base branch files that were incorrectly filtered
bdenham e651572
fix: Clean Company Switcher enrichment parameters
bdenham 35c7a5f
Merge branch 'releases/b2b-infrastructure' into b2b-docs-quote-manageβ¦
bdenham bd345cd
chore: Merge latest infrastructure and safeguards from base
bdenham 77c6027
fix: Allow safeguard files in feature branch validation
bdenham b098a23
fix: Allow ALL .github files in feature branches
bdenham d107864
fix: Use --legacy-peer-deps for npm install in validation workflow
bdenham 82d4cf4
chore: Merge astro.config.mjs from base
bdenham f0d0e8e
fix: DISABLE validation workflow temporarily
bdenham 8ce43b3
fix: add missing astro.redirects.mjs file
bdenham 7356c36
fix: remove boilerplate/blocks directory causing build failure
bdenham 4259255
fix: update release notes links to merchant personalization guide
bdenham b39988f
fix: complete B2B dropins sidebar and add all 30 B2B commerce blocks
bdenham 003d3a5
docs: add B2B commerce blocks identification and verification reference
bdenham 3a7f4a6
fix: remove orphaned pages and apply content fixes
bdenham 9d70d5a
fix: add B2B dropins overview page and correct sidebar link
bdenham 5bd7ea1
refactor: restructure sidebar - move B2C drop-ins out as sibling, renβ¦
bdenham 1385aeb
fix: add missing Prerendered product pages to content customizations β¦
bdenham File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,240 @@ | ||
| # B2B Commerce Blocks Reference | ||
|
|
||
| This document provides the definitive reference for identifying and verifying B2B commerce blocks across all branches. | ||
|
|
||
| ## Block Counts | ||
|
|
||
| - **B2C Commerce blocks**: 24 files | ||
| - **B2B Commerce blocks**: 30 files | ||
| - **Total Commerce blocks**: 54 files | ||
|
|
||
| ## File Locations | ||
|
|
||
| All commerce block documentation files are located in: | ||
| ``` | ||
| src/content/docs/merchants/blocks/ | ||
| ``` | ||
|
|
||
| ## B2B Block Identification Patterns | ||
|
|
||
| B2B commerce blocks follow these naming patterns: | ||
|
|
||
| ### 1. Purchase Order blocks (18 files) | ||
| Prefix: `commerce-b2b-po-*` and `commerce-b2b-negotiable-quote*` and related | ||
| - `commerce-b2b-negotiable-quote.mdx` | ||
| - `commerce-b2b-negotiable-quote-template.mdx` | ||
| - `commerce-b2b-po-approval-flow.mdx` | ||
| - `commerce-b2b-po-approval-rule-details.mdx` | ||
| - `commerce-b2b-po-approval-rule-form.mdx` | ||
| - `commerce-b2b-po-approval-rules-list.mdx` | ||
| - `commerce-b2b-po-checkout-success.mdx` | ||
| - `commerce-b2b-po-comment-form.mdx` | ||
| - `commerce-b2b-po-comments-list.mdx` | ||
| - `commerce-b2b-po-company-purchase-orders.mdx` | ||
| - `commerce-b2b-po-customer-purchase-orders.mdx` | ||
| - `commerce-b2b-po-header.mdx` | ||
| - `commerce-b2b-po-history-log.mdx` | ||
| - `commerce-b2b-po-require-approval-purchase-orders.mdx` | ||
| - `commerce-b2b-po-status.mdx` | ||
| - `commerce-b2b-quote-checkout.mdx` | ||
| - `commerce-b2b-requisition-list.mdx` | ||
| - `commerce-b2b-requisition-list-view.mdx` | ||
|
|
||
| ### 2. Company Management blocks (7 files) | ||
| Prefix: `commerce-company-*` | ||
| - `commerce-company-accept-invitation.mdx` | ||
| - `commerce-company-create.mdx` | ||
| - `commerce-company-credit.mdx` | ||
| - `commerce-company-profile.mdx` | ||
| - `commerce-company-roles-permissions.mdx` | ||
| - `commerce-company-structure.mdx` | ||
| - `commerce-company-users.mdx` | ||
|
|
||
| ### 3. Customer Company blocks (1 file) | ||
| - `commerce-customer-company.mdx` | ||
|
|
||
| ### 4. Shared B2B blocks (4 files) | ||
| These blocks are used by both B2B and B2C contexts but documented as B2B: | ||
| - `commerce-account-header.mdx` | ||
| - `commerce-account-nav.mdx` | ||
| - `commerce-account-sidebar.mdx` | ||
| - `commerce-checkout-success.mdx` | ||
|
|
||
| ## Verification Commands | ||
|
|
||
| ### Count all B2B commerce blocks | ||
| ```bash | ||
| ls -1 src/content/docs/merchants/blocks/ | \ | ||
| grep -E "commerce-b2b-|commerce-company-|commerce-customer-company|commerce-checkout-success|commerce-account-header|commerce-account-nav|commerce-account-sidebar" | \ | ||
| wc -l | ||
| ``` | ||
| Expected output: `30` | ||
|
|
||
| ### List all B2B commerce blocks (sorted) | ||
| ```bash | ||
| ls -1 src/content/docs/merchants/blocks/ | \ | ||
| grep -E "commerce-b2b-|commerce-company-|commerce-customer-company|commerce-checkout-success|commerce-account-header|commerce-account-nav|commerce-account-sidebar" | \ | ||
| sed 's/.mdx$//' | sort | ||
| ``` | ||
|
|
||
| ### Count all B2C commerce blocks | ||
| ```bash | ||
| ls -1 src/content/docs/merchants/blocks/*.mdx | \ | ||
| grep -v "commerce-b2b-\|commerce-company-\|commerce-customer-company\|commerce-checkout-success\|commerce-account-header\|commerce-account-nav\|commerce-account-sidebar" | \ | ||
| wc -l | ||
| ``` | ||
| Expected output: `24` | ||
|
|
||
| ### Verify sidebar matches files | ||
| ```bash | ||
| # Extract B2B blocks from sidebar | ||
| sed -n '/label: .B2B Commerce blocks.,$/,/^ },$/p' astro.sidebar.mjs | \ | ||
| grep "link: '/merchants/blocks/" | \ | ||
| sed "s/.*'\/merchants\/blocks\/\(.*\)\/'.*/\1/" | \ | ||
| sort > /tmp/sidebar-b2b.txt | ||
|
|
||
| # List B2B files | ||
| ls -1 src/content/docs/merchants/blocks/ | \ | ||
| grep -E "commerce-b2b-|commerce-company-|commerce-customer-company|commerce-checkout-success|commerce-account-header|commerce-account-nav|commerce-account-sidebar" | \ | ||
| sed 's/.mdx$//' | sort > /tmp/files-b2b.txt | ||
|
|
||
| # Compare | ||
| diff /tmp/sidebar-b2b.txt /tmp/files-b2b.txt | ||
| ``` | ||
| Expected output: No differences (empty output) | ||
|
|
||
| ## Sidebar Structure | ||
|
|
||
| The B2B commerce blocks are organized in `astro.sidebar.mjs` under: | ||
| ``` | ||
| Merchants | ||
| βββ B2B Commerce blocks (collapsed) | ||
| βββ Account Header | ||
| βββ Account Nav | ||
| βββ Account Sidebar | ||
| βββ Checkout Success | ||
| βββ Company Accept Invitation | ||
| βββ Company Create | ||
| βββ Company Credit | ||
| βββ Company Profile | ||
| βββ Company Roles & Permissions | ||
| βββ Company Structure | ||
| βββ Company Users | ||
| βββ Customer Company | ||
| βββ Negotiable Quote | ||
| βββ Negotiable Quote Template | ||
| βββ Purchase Order Approval Flow | ||
| βββ Purchase Order Approval Rule Details | ||
| βββ Purchase Order Approval Rule Form | ||
| βββ Purchase Order Approval Rules List | ||
| βββ Purchase Order Checkout Success | ||
| βββ Purchase Order Comment Form | ||
| βββ Purchase Order Comments List | ||
| βββ Purchase Order Company List | ||
| βββ Purchase Order Customer List | ||
| βββ Purchase Order Header | ||
| βββ Purchase Order History Log | ||
| βββ Purchase Order Require Approval List | ||
| βββ Purchase Order Status | ||
| βββ Quote Checkout | ||
| βββ Requisition List | ||
| βββ Requisition List View | ||
| ``` | ||
|
|
||
| ## Branch Consistency | ||
|
|
||
| These 30 B2B commerce blocks must be present and correctly linked in the sidebar across all B2B branches: | ||
|
|
||
| ### Release Branches | ||
| - `releases/b2b-nov-release` | ||
| - `releases/b2b-infrastructure` | ||
| - `releases/b2b-docs-only` | ||
|
|
||
| ### Feature Branches | ||
| - `b2b-docs-company-management-v2` | ||
| - `b2b-docs-company-switcher-v2` | ||
| - `b2b-docs-purchase-order` (merged to release) | ||
| - `b2b-docs-quote-management-v2` | ||
| - `b2b-docs-requisition-list-v3` | ||
|
|
||
| ### Preview Branch | ||
| - `b2b-preview` (GitHub Pages deployment) | ||
|
|
||
| ## Common Issues and Solutions | ||
|
|
||
| ### Issue: Missing blocks in sidebar | ||
| **Symptom**: Build fails with "Failed to find the topic for" errors | ||
| **Solution**: Verify all 30 blocks are listed in the "B2B Commerce blocks" section of `astro.sidebar.mjs` | ||
|
|
||
| ### Issue: Incorrect block count | ||
| **Symptom**: Verification commands show count β 30 | ||
| **Solution**: Run the verification commands above to identify missing or extra files | ||
|
|
||
| ### Issue: Orphaned block pages | ||
| **Symptom**: Build fails with "Failed to find the topic" for a specific block | ||
| **Solution**: Either add the block to the sidebar or delete the file if it shouldn't exist | ||
|
|
||
| ### Issue: Invalid links to blocks | ||
| **Symptom**: Build fails with "invalid links" errors | ||
| **Solution**: Ensure all sidebar links follow the pattern `/merchants/blocks/[block-name]/` | ||
|
|
||
| ## Regeneration Workflow | ||
|
|
||
| When regenerating documentation for B2B branches: | ||
|
|
||
| 1. **Verify B2B blocks are present**: | ||
| ```bash | ||
| ls -1 src/content/docs/merchants/blocks/ | grep -E "commerce-b2b-|commerce-company-|commerce-customer-company|commerce-checkout-success|commerce-account-header|commerce-account-nav|commerce-account-sidebar" | wc -l | ||
| ``` | ||
| Should return: `30` | ||
|
|
||
| 2. **Verify sidebar entries**: | ||
| ```bash | ||
| sed -n '/label: .B2B Commerce blocks.,$/,/^ },$/p' astro.sidebar.mjs | grep "label:" | grep -v "B2B Commerce blocks" | wc -l | ||
| ``` | ||
| Should return: `30` | ||
|
|
||
| 3. **Run build test**: | ||
| ```bash | ||
| pnpm run build:prod-fast | ||
| ``` | ||
| Should complete with zero errors. | ||
|
|
||
| ## Architecture Notes | ||
|
|
||
| ### Why These Patterns? | ||
|
|
||
| The B2B block identification patterns are based on: | ||
| 1. **Source repository structure**: Blocks are organized by feature area (Purchase Order, Company Management, etc.) | ||
| 2. **Naming conventions**: Adobe Commerce uses prefixes to indicate feature scope | ||
| 3. **Historical context**: Some blocks (`commerce-account-*`, `commerce-checkout-success`) are shared between B2B and B2C but documented in the B2B section | ||
|
|
||
| ### B2B vs B2C Separation | ||
|
|
||
| - **B2C blocks** (24): Core commerce functionality for all customers | ||
| - **B2B blocks** (30): Business-specific features (Purchase Orders, Company Management, Requisition Lists) | ||
| - **Sidebar separation**: Two distinct sections prevent confusion and improve navigation | ||
|
|
||
| ### File Restoration | ||
|
|
||
| The 30 B2B commerce blocks were restored from git history (`45dd67bb~1`) on 2024-12-19 after being inadvertently removed during a merge from the `develop` branch. The restoration ensures: | ||
| - Complete B2B feature documentation | ||
| - Proper sidebar navigation structure | ||
| - Zero build errors on `b2b-preview` branch | ||
| - Consistent documentation across all B2B branches | ||
|
|
||
| ## Last Verified | ||
|
|
||
| - **Date**: 2024-12-19 | ||
| - **Branch**: `b2b-preview` | ||
| - **Files**: 30 B2B blocks present and correctly linked | ||
| - **Build**: Passed with zero errors | ||
| - **Command**: `pnpm run build:prod-fast` | ||
|
|
||
| ## Related Documentation | ||
|
|
||
| - `B2B-SIDEBAR-AND-BLOCKS-FIXED.md` - Complete fix documentation | ||
| - `B2B-PREVIEW-WORKFLOW.md` - Branch workflow and merge strategy | ||
| - `B2B-WORKFLOW-GUIDE.md` - Overall B2B documentation workflow | ||
| - `astro.sidebar.mjs` - Sidebar configuration (lines 723-757) | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please explain this change