Fix: Add PizzaShack backend note for distributed setup #9872 [4.6.0]

[Walapalam]

Purpose

Resolves #9872. PizzaShack sample fails in distributed setup because backend isn't included.

Goals

Instruct users to host the 'pizzashack.war' separately for distributed deployments.

Approach

Added an '!!! Note' block in 'deploying-wso2-api-m-in-a-distributed-setup.md'.

User stories

As a DevOps engineer, I want to know why PizzaShack isn't working in my distributed cluster.

Release note

Fixed documentation issue regarding Resolves #9872. PizzaShack sample fails in distributed setup because backend isn't included..

Documentation

Updates 'deploying-wso2-api-m-in-a-distributed-setup.md'.

Training

N/A

Certification

N/A

Marketing

N/A

Automation tests

• Unit tests

  N/A (Documentation change only)

• Integration tests

  N/A (Documentation change only)

Security checks

• Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes
• Ran FindSecurityBugs plugin and verified report? yes
• Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes

Samples

N/A

Related PRs

Parallel PR targeting 'master' branch.

Migrations (if applicable)

N/A

Test environment

Local MkDocs build.

Learning

Reviewed existing documentation and verified links/commands.

[coderabbitai]

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.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[CLAassistant]

All committers have signed the CLA.

[Copilot]

Pull request overview

This PR adds documentation to address issue #9872, where users encounter failures when trying to use the PizzaShack sample API in a distributed WSO2 API-M deployment. The change clarifies that the PizzaShack backend must be hosted separately in distributed setups.

• Adds an informational Note block explaining the PizzaShack backend deployment requirement
• Instructs users to host pizzashack.war on a separate application server or container
• Ensures users understand the backend must be accessible to the Gateway component

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Consider using "component distributions" instead of "API-M components" to maintain consistency with the terminology used elsewhere in this document (see line 3 and line 8 which reference "component distribution").

Suggested change

	To use the PizzaShack sample API in a distributed deployment, you need to host the sample PizzaShack backend (`pizzashack.war`) on a separate application server or container, as the backend is not included in the distributed API-M components by default. Ensure the backend URL is accessible to the Gateway.
	To use the PizzaShack sample API in a distributed deployment, you need to host the sample PizzaShack backend (`pizzashack.war`) on a separate application server or container, as the backend is not included in the API-M component distributions by default. Ensure the backend URL is accessible to the Gateway.

[tharikaGitHub]

Hi @Walapalam,

Thank you for your contribution. Shall we port the same fix in the following PRs[1][2] to the relevant pages so that we are consistent across versions?

[1] #9873
[2] #9885

Thanks,
Tharika.

[tharikaGitHub]

Hi @Walapalam,

I will close this PR as it has been inactive for some time. Please reopen once the requested changes are added.

Thanks,
Tharika.