[Feature] ko/datagateway review #41
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive client-facing documentation for Data Gateway, SHI's secure data layer that unifies access to product and tenant information across SHI solutions. The documentation provides guidance for admins, operators, and analysts who will use the Data Gateway UI or connect via the public API.
Key changes include:
- Created complete documentation structure with Overview, Usage Guide, Architecture, Reference, Deployment, and Troubleshooting pages
- Added interactive Mermaid diagrams showing system architecture and data flows
- Updated navigation structure in mkdocs.yml to organize the new content
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Added navigation entries for new Data Gateway documentation sections |
| docs/Data-Gateway/index.md | Complete rewrite providing overview, features, and high-level architecture diagram |
| docs/Data-Gateway/Usage-Guide/index.md | New comprehensive guide covering LicenseGPT, Tenant Manager, and API access |
| docs/Data-Gateway/Troubleshooting.md | New placeholder page for future troubleshooting content |
| docs/Data-Gateway/Reference/index.md | New reference documentation covering authentication, endpoints, and error handling |
| docs/Data-Gateway/Deployment/index.md | New deployment guide explaining SHI-hosted nature of the service |
| docs/Data-Gateway/Architecture/index.md | New architecture overview page |
| docs/Data-Gateway/Architecture/Infrastructure.md | Complete rewrite with detailed infrastructure diagrams and component descriptions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
elliot-huffman
changed the title
Add steps for the Enterprise App registration process.
Add additional charts. Correct existing charts. Add additional information about the update service. Add links to the component map table. Change from bold section headers to actual headers.
Replaced stylized apostrophe with standard one.
The API routes had the wrong capitalization and were missing prefixes. In the case of the health check route, it was completely wrong. Remove an un-needed chart on the reference index page since the architecture pages have the expected content. Correct some wording.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds client-facing documentation for Data Gateway
Changes
Added Overview, Usage Guide, Architecture, Reference, Deployment, Troubleshooting pages.
Updated mkdocs.yml navigation.
Added Mermaid diagrams, examples, and consistent “Use case” notes.