Update and rename schema-registry-beta.md to schema-registry.md by SupreetMann-Solace · Pull Request #364 · SolaceDev/solace-dev-codelabs

SupreetMann-Solace · 2025-08-22T20:29:26Z

✨ PR Description

Purpose: Update schema registry documentation from beta to GA release with expanded features and deployment options.

Main changes:
- Renamed file from schema-registry-beta.md to schema-registry.md to reflect GA status
- Added REST messaging examples alongside existing JCSMP implementation
- Expanded deployment options to include both Docker Compose and Kubernetes methods
- Updated schema examples from Avro to JSON Schema format
- Added external identity provider configuration options for enterprise security

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

solacecommunity-bot · 2025-08-22T20:29:57Z

Thanks for opening up a PR and contributing to our open source codelabs!

Review process Guidelines

Once the PR is opened, tag at least one Technical Reviewer

Technical Reviewer Responsibilities

Dry-run technical steps
Review technical positioning/messaging
Point out typos and potential formatting issues
Technical Reviewer(s): "Approve" or "Request Changes" by navigating to the Files changed tab and click on the "Review Changes" drop down

Post Technical Review

A member of the Developer Advocate Team will review overall structure and merge into master which will push it to production

gitstream-cm · 2025-08-22T20:30:33Z

Please mark whether you used Copilot to assist coding in this PR

Copilot Assisted

github-actions · 2025-08-22T20:31:09Z

🚀 Deployed on https://68ae04e5ce139d16c94fdb39--codelabs-solace.netlify.app

gitstream-cm

✨ PR Review

The PR successfully updates the schema registry documentation from beta to GA version with comprehensive changes to support Solace Schema Registry. However, there are several placeholder content and formatting issues that need to be addressed before publication.

3 issues detected:

🎯 Scope - Placeholder text and incomplete content remains in production documentation

Details: The documentation contains unfinished placeholder content that will confuse users. There are "TBD" video references and "Insert image" placeholders that need to be completed before publication.
File: markdown/schema-registry-beta/schema-registry.md

🧾 Readability - Mixed usage of "SERDES" and "SERDEs" creates terminology inconsistency

Details: The document uses both "SERDES" and "SERDEs" inconsistently throughout the content, which may confuse readers about the correct terminology.
File: markdown/schema-registry-beta/schema-registry.md

🧾 Readability - Non-standard markdown syntax may not render properly

Details: The note formatting uses [!NOTE] syntax which is not standard markdown and may not render correctly in all markdown processors.
File: markdown/schema-registry-beta/schema-registry.md

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

Chaymee

Found a few things that we need to address before approval

Chaymee · 2025-08-26T14:46:18Z

+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "ClockInOut",


title needs to be clock-in-out to match the JCSMP sample

gitstream-cm

✨ PR Review

The PR successfully updates the documentation from Apicurio Registry to Solace Schema Registry with comprehensive changes including deployment methods and code examples. However, there are some technical inaccuracies and incomplete content that need attention.

2 issues detected:

🐞 Bug - Documentation states "Avro schema" but the actual content is a JSON schema format.

Details: The documentation incorrectly references "Avro schema" when describing JSON schema content. This mismatch between the description and actual schema format will confuse users about what type of schema they are working with.
File: markdown/schema-registry-beta/schema-registry.md (177-177)

🐞 Bug - Windows command has malformed syntax with duplicate patterns and incorrect variable references.

Details: The Windows command syntax for loading Docker images contains syntax errors with duplicate patterns and incorrect escaping that will cause execution failures.
File: markdown/schema-registry-beta/schema-registry.md (94-94)

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

gitstream-cm

✨ PR Review

The PR significantly updates the schema registry documentation by renaming it from beta to GA and updating content to focus on Solace Schema Registry instead of Apicurio Registry. However, several placeholder content and syntax issues remain that need to be addressed.

3 issues detected:

🧾 Readability - Placeholder text "Insert image" remains in the documentation making it appear unfinished.

Details: The documentation still contains unfinished placeholder content with "Insert image" that will confuse users and indicates incomplete documentation.
File: markdown/schema-registry-beta/schema-registry.md (144-144)

🐞 Bug - The command contains duplicate *.tar.gz patterns and incorrect spacing that will prevent proper execution.

Details: The Windows command for loading Docker images has syntax errors with duplicate file patterns that will cause execution failures.
File: markdown/schema-registry-beta/schema-registry.md (94-94)

🧾 Readability - Non-standard [!NOTE] syntax may not render properly across different markdown processors.

Details: The document uses [!NOTE] syntax which is not standard markdown and may not render correctly in all markdown processors.
File: markdown/schema-registry-beta/schema-registry.md (315-315)

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

gitstream-cm · 2025-08-26T17:08:03Z

+
+
+2. Open a terminal or command prompt window and navigate to the extracted location of the folder called ```solace-schema-registry-dist```.
+3. Run the command ```for img in {docker-images}/*.tar.gz; do docker load -i "$img"; done``` to load docker images. For Window use this instead ```for %i in (docker-images\*.tar.gz \*.tar.gz) do docker load -i "%i"```.


🐞 Bug - Windows Command Syntax: Fix the Windows command to use correct syntax: for %i in (docker-images\*.tar.gz) do docker load -i "%i"

Suggested change

3. Run the command ```for img in {docker-images}/*.tar.gz; do docker load -i "$img"; done``` to load docker images. For Window use this instead ```for %i in (docker-images\*.tar.gz \*.tar.gz) do docker load -i "%i"```.

3. Run the command ```for img in {docker-images}/*.tar.gz; do docker load -i "$img"; done``` to load docker images. For Window use this instead ```for %i in (docker-images\*.tar.gz) do docker load -i "%i"```.

gitstream-cm

✨ PR Review

The PR successfully transitions from the beta Apicurio Registry documentation to the GA Solace Schema Registry version with comprehensive updates. However, several technical issues from the previous version persist and need attention.

3 issues detected:

🐞 Bug - Duplicate file patterns in Windows batch command syntax will prevent proper execution.

Details: The Windows command for loading Docker images contains duplicate file patterns that will cause execution failures when users attempt to run the command.
File: markdown/schema-registry-beta/schema-registry.md (94-94)

🧾 Readability - Placeholder content in published documentation creates confusion and indicates incomplete preparation.

Details: The documentation contains an "Insert image" placeholder that indicates incomplete content and will confuse users who expect a complete walkthrough.
File: markdown/schema-registry-beta/schema-registry.md (144-144)

🧾 Readability - Non-standard markdown syntax may fail to render properly across different markdown processors.

Details: The documentation uses [!NOTE] syntax which is not standard markdown and may not render correctly in all markdown processors, potentially causing display issues.
File: markdown/schema-registry-beta/schema-registry.md

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

gitstream-cm

✨ PR Review

The documentation has been significantly updated to focus on Solace Schema Registry instead of Apicurio Registry, with improved consistency in terminology. However, there are still some incomplete placeholder content and command syntax errors that need to be addressed.

3 issues detected:

🧾 Readability - The word "postive" should be "positive" on line 77.

Details: There is a spelling error in the markdown aside directive that could affect document rendering or readability.
File: markdown/schema-registry-beta/schema-registry.md (77-77)

🐞 Bug - The Windows command contains duplicate patterns "docker-images\*.tar.gz \*.tar.gz" which will cause command execution errors.

Details: The Windows command for loading Docker images contains duplicate file patterns that will cause execution failures when users attempt to run the command.
File: markdown/schema-registry-beta/schema-registry.md (93-93)

🧾 Readability - The documentation contains an unfinished "Insert image" placeholder.

Details: The documentation contains an "Insert image" placeholder that indicates incomplete content and will confuse users who expect a complete walkthrough.
File: markdown/schema-registry-beta/schema-registry.md (143-143)

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

gitstream-cm

✨ PR Review

The PR successfully updates the schema registry documentation from beta to GA version with comprehensive improvements including better structure, consistent terminology, and updated examples. However, several previously identified issues remain unresolved.

3 issues detected:

🐞 Bug - Typo in the word "positive" spelled as "postive"

Details: The markdown aside directive contains a spelling error that affects readability and document professionalism.
File: markdown/schema-registry-beta/schema-registry.md (77-77)

🐞 Bug - Windows command contains duplicate file patterns causing syntax errors

Details: The Windows command for loading Docker images contains duplicate file patterns that will cause execution failures when users attempt to run the command on Windows systems.
File: markdown/schema-registry-beta/schema-registry.md (93-93)

🧹 Maintainability - Placeholder text "Insert image" indicates incomplete documentation

Details: The documentation contains an "Insert image" placeholder that indicates incomplete content and will confuse users who expect a complete walkthrough.
File: markdown/schema-registry-beta/schema-registry.md (143-143)

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

gitstream-cm

✨ PR Review

The PR successfully updates the documentation from Apicurio Registry to Solace Schema Registry with comprehensive content covering both Docker and Kubernetes deployments. However, there are still some unfinished elements and command syntax issues that need to be addressed.

2 issues detected:

🐞 Bug - The command contains duplicate file patterns "\*.tar.gz" that will cause syntax errors during execution.

Details: The Windows command for loading Docker images contains duplicate file patterns that will cause execution failures when users attempt to run the command on Windows systems.
File: markdown/schema-registry-beta/schema-registry.md (93-93)

🧾 Readability - Placeholder text "Insert image" appears in the final documentation instead of actual content.

Details: The documentation contains an "Insert image" placeholder that indicates incomplete content and will confuse users who expect a complete walkthrough.
File: markdown/schema-registry-beta/schema-registry.md (143-143)

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

removed old images, added small fixes and sample images for creating RDP

gitstream-cm

✨ PR Review

The PR successfully updates the documentation from beta to GA, changing focus from Apicurio Registry to Solace Schema Registry and from Avro to JSON schemas. However, some previously identified issues remain unresolved.

2 issues detected:

🐞 Bug - The command has redundant file pattern specification that will cause syntax errors during execution.

Details: The Windows command for loading Docker images contains duplicate file patterns that will cause execution failures when users attempt to run the command on Windows systems.
File: markdown/schema-registry-beta/schema-registry.md (93-93)

🧾 Readability - Placeholder text indicates unfinished documentation content.

Details: The documentation contains an "Insert image" placeholder that indicates incomplete content and will confuse users who expect a complete walkthrough.
File: markdown/schema-registry-beta/schema-registry.md (143-143)

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

sdewilde

The actual codelab HTML still calls this the beta and mentions apicurio. We can't only change the markdown folder

Chaymee · 2025-08-26T19:06:15Z

New code lab looks good

Chaymee

New codelab looks good to go with minor changes

Update and rename schema-registry-beta.md to schema-registry.md

f1d0164

SupreetMann-Solace and others added 5 commits August 23, 2025 11:31

Add files via upload

f31939c

Updated schema-registry.md

d51d56f

Add files via upload

2526520

Update schema-registry.md

6bab9d9

Fixed spacing between code blocks

6725a6c

sdewilde reviewed Aug 26, 2025

View reviewed changes

Chaymee marked this pull request as ready for review August 26, 2025 13:57

Update schema-registry.md

56757e8

gitstream-cm Bot reviewed Aug 26, 2025

View reviewed changes

Chaymee requested changes Aug 26, 2025

View reviewed changes

Chaymee self-assigned this Aug 26, 2025

SupreetMann-Solace added 2 commits August 26, 2025 12:51

Update schema-registry.md

857497a

Add files via upload

0240ed6

gitstream-cm Bot reviewed Aug 26, 2025

View reviewed changes

Comment thread markdown/schema-registry-beta/schema-registry.md Outdated

Comment thread markdown/schema-registry-beta/schema-registry.md

Update schema-registry.md

3768335

gitstream-cm Bot reviewed Aug 26, 2025

View reviewed changes

SupreetMann-Solace added 2 commits August 26, 2025 13:08

Update schema-registry.md

850b28a

Update schema-registry.md

15b1bb8

gitstream-cm Bot reviewed Aug 26, 2025

View reviewed changes

Comment thread markdown/schema-registry-beta/schema-registry.md

Comment thread markdown/schema-registry-beta/schema-registry.md

SupreetMann-Solace and others added 2 commits August 26, 2025 13:49

Add files via upload

9aff473

Merge branch 'update/schema-registry-1' into update/schema-registry

1b93786

Chaymee mentioned this pull request Aug 26, 2025

Add files via upload #365

Closed

SupreetMann-Solace added 2 commits August 26, 2025 14:12

Update schema-registry.md

ea3eb1c

Update schema-registry.md

8de5368

gitstream-cm Bot reviewed Aug 26, 2025

View reviewed changes

Comment thread markdown/schema-registry-beta/schema-registry.md Outdated

Comment thread markdown/schema-registry-beta/schema-registry.md

Comment thread markdown/schema-registry-beta/schema-registry.md

Update schema-registry.md

e532aba

Update schema-registry.md

f8893a2

gitstream-cm Bot reviewed Aug 26, 2025

View reviewed changes

Comment thread markdown/schema-registry-beta/schema-registry.md Outdated

Comment thread markdown/schema-registry-beta/schema-registry.md

Comment thread markdown/schema-registry-beta/schema-registry.md

Update schema-registry.md

8ad3aa6

gitstream-cm Bot reviewed Aug 26, 2025

View reviewed changes

Comment thread markdown/schema-registry-beta/schema-registry.md

Comment thread markdown/schema-registry-beta/schema-registry.md

Final commit

6a39cf0

removed old images, added small fixes and sample images for creating RDP

gitstream-cm Bot reviewed Aug 26, 2025

View reviewed changes

Comment thread markdown/schema-registry-beta/schema-registry.md

Comment thread markdown/schema-registry-beta/schema-registry.md

sdewilde suggested changes Aug 26, 2025

View reviewed changes

Chaymee approved these changes Aug 26, 2025

View reviewed changes

Chaymee merged commit ea27c3f into master Aug 26, 2025
6 checks passed

Chaymee deleted the update/schema-registry branch August 26, 2025 19:08



		2. Open a terminal or command prompt window and navigate to the extracted location of the folder called ```solace-schema-registry-dist```.
		3. Run the command ```for img in {docker-images}/.tar.gz; do docker load -i "$img"; done``` to load docker images. For Window use this instead ```for %i in (docker-images\.tar.gz \*.tar.gz) do docker load -i "%i"```.

Conversation

SupreetMann-Solace commented Aug 22, 2025 • edited by gitstream-cm Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✨ PR Description

Uh oh!

solacecommunity-bot commented Aug 22, 2025

Review process Guidelines

Technical Reviewer Responsibilities

Post Technical Review

Uh oh!

gitstream-cm Bot commented Aug 22, 2025

Uh oh!

github-actions Bot commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gitstream-cm Bot left a comment

Choose a reason for hiding this comment

✨ PR Review

Uh oh!

Chaymee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Chaymee Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

SupreetMann-Solace Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gitstream-cm Bot left a comment

Choose a reason for hiding this comment

✨ PR Review

Uh oh!

Uh oh!

Uh oh!

gitstream-cm Bot left a comment

Choose a reason for hiding this comment

✨ PR Review

Uh oh!

Uh oh!

gitstream-cm Bot Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gitstream-cm Bot left a comment

Choose a reason for hiding this comment

✨ PR Review

Uh oh!

Uh oh!

Uh oh!

gitstream-cm Bot left a comment

Choose a reason for hiding this comment

✨ PR Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gitstream-cm Bot left a comment

Choose a reason for hiding this comment

✨ PR Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gitstream-cm Bot left a comment

Choose a reason for hiding this comment

✨ PR Review

SupreetMann-Solace commented Aug 22, 2025 •

edited by gitstream-cm Bot

Loading

github-actions Bot commented Aug 22, 2025 •

edited

Loading