feat: update tutorials for Membrane API Gateway

[predic8]

• Removed obsolete membrane.sh script for REST tutorial.
• Enhanced advanced, JSON, and XML tutorials with clearer starting instructions and feature descriptions.
• Added new SOAP tutorial, including introductory documentation, configuration (10-Sample-SOAP-Service.yaml), and example script (invoke-sample-soap-service.sh).
• Fixed command inconsistency in 10-PathParameters.yaml.

Summary by CodeRabbit

• Documentation

  • Updated tutorial guides for advanced features, JSON, and XML topics with clearer descriptions and improved navigation
  • Clarified prerequisite requirements for tutorial completion

• New Features

  • Added SOAP integration tutorial with sample service configuration file
  • Included SOAP service invocation example scripts

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Important

Review skipped

Draft detected.

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

Walkthrough

This PR updates tutorial documentation and adds a new SOAP tutorial module. Changes include standardizing startup instructions across advanced tutorials, restructuring README files for the advanced, JSON, and XML tutorials, introducing a complete SOAP tutorial with configuration file and invocation script, and removing the membrane.sh shell script from the REST tutorials folder.

Changes

Cohort / File(s)	Summary
Startup instruction standardization distribution/tutorials/advanced/10-PathParameters.yaml	Updated shell invocation path from membrane.sh -c to ./membrane.sh -c
Tutorial documentation restructuring distribution/tutorials/advanced/README.md, distribution/tutorials/json/README.md, distribution/tutorials/xml/README.md	Reworded introductions; updated cross-references; added guidance directives pointing to specific tutorial files; removed generic Getting Started references; aligned each README to its respective technology focus
SOAP tutorial introduction distribution/tutorials/soap/10-Sample-SOAP-Service.yaml, distribution/tutorials/soap/README.md, distribution/tutorials/soap/invoke-sample-soap-service.sh	Added new SOAP tutorial module with API configuration (port 2000, city-service endpoint), documentation outlining planned features (SOAPProxy, soapTemplate), and curl-based invocation script to test the sample service
Shell script removal distribution/tutorials/rest/membrane.sh	Removed shell script that previously handled Membrane startup, environment validation, Java version checking, and error reporting

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify the rationale for removing distribution/tutorials/rest/membrane.sh and ensure no critical startup functionality is lost or duplicated elsewhere
• Confirm SOAP tutorial configuration file correctness and alignment with existing Membrane API Gateway patterns
• Validate that removed startup shell script is not referenced elsewhere in the codebase

Possibly related PRs

• membrane/api-gateway#2391: Standardizes tutorial startup instructions by changing membrane.sh to ./membrane.sh across tutorial files
• membrane/api-gateway#2306: Modifies the same file (distribution/tutorials/advanced/10-PathParameters.yaml) with schema header updates

Suggested labels

7.x

Suggested reviewers

• christiangoerdes
• rrayst

Poem

🐰 The tutorials hop along with grace,
SOAP now finds its rightful place,
Paths are clearer, READMEs shine,
Documentation, now divine!
With relative paths, we guide the way,
Hopping forward, every day! 🌟

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: update tutorials for Membrane API Gateway' accurately describes the main objective of the changeset, which encompasses updates to multiple tutorial files including enhancements to existing tutorials and addition of a new SOAP tutorial.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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.}

[predic8]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

distribution/tutorials/xml/README.md (1)

11-13: Consider removing or relocating the TBD section.

The TBD section in user-facing tutorial documentation may create confusion or appear unpolished to users. Consider one of these alternatives:

1. Remove the TBD section until XSLT transformation content is ready
2. Track it internally (e.g., in a GitHub issue) instead of exposing it in tutorials
3. If you want to indicate planned features, rephrase it more positively: "Additional topics coming soon: XSLT transformation"

Option to remove TBD section

-
-
-## TBD:
-
-- XSLT transformation

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8afa4fc and fe858a4.

📒 Files selected for processing (8)

• distribution/tutorials/advanced/10-PathParameters.yaml
• distribution/tutorials/advanced/README.md
• distribution/tutorials/json/README.md
• distribution/tutorials/rest/membrane.sh
• distribution/tutorials/soap/10-Sample-SOAP-Service.yaml
• distribution/tutorials/soap/README.md
• distribution/tutorials/soap/invoke-sample-soap-service.sh
• distribution/tutorials/xml/README.md

💤 Files with no reviewable changes (1)

• distribution/tutorials/rest/membrane.sh

🧰 Additional context used

🪛 Shellcheck (0.11.0)

distribution/tutorials/soap/invoke-sample-soap-service.sh

[error] 1-1: Tips depend on target shell and yours is unknown. Add a shebang or a 'shell' directive.

(SC2148)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (java)

🔇 Additional comments (3)

distribution/tutorials/xml/README.md (1)

1-8: Well-structured tutorial introduction - referenced file confirmed.

The XML tutorial introduction is clear and well-organized. The reference to 10-JSON-to-XML.yaml is valid and the file exists in the xml tutorials directory.

distribution/tutorials/advanced/README.md (1)

3-15: Excellent tutorial restructuring with clear prerequisites and starting point.

The changes improve the tutorial by:

• Using the full product name "Membrane API Gateway" for clarity
• Establishing a clear prerequisite (Getting Started tutorial)
• Providing a specific starting point (10-PathParameters.yaml)
• Maintaining consistency with the JSON and XML tutorial structure

The Getting Started tutorial path reference is correct.

distribution/tutorials/advanced/10-PathParameters.yaml (1)

8-8: Verify that membrane.sh is accessible from the advanced directory.

The startup instruction now uses ./membrane.sh as a relative path. Given that the PR removes distribution/tutorials/rest/membrane.sh, please confirm that:

1. The membrane.sh script exists in the distribution/tutorials/advanced/ directory, or
2. Users are expected to run this command from a different working directory

This ensures the tutorial instructions work correctly for users.

[membrane-ci-server]

This pull request needs "/ok-to-test" from an authorized committer.

[predic8]

/ok-to-test