Documentation Update for the windows environment - #492
Open
NethmikaKekuu wants to merge 8 commits into
Open
Conversation
Contributor
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
📝 WalkthroughWalkthroughThe PR updates installation and service README documentation. It pins Ballerina, adds local database setup, documents Windows PowerShell workflows, adds service environment templates, and separates generation, testing, and startup instructions. ChangesSetup documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 11
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/docs/getting_started/installation.md`:
- Line 37: Update the installation instructions near the Docker alternative to
refer to starting CORE in step 2 instead of step 3, while preserving the
existing step 3 reference for ingestion-api where applicable.
- Line 26: Rename the “Start the System (Locally, without Docker)” section
heading to accurately cover both database options, using “Start the System
Locally” or “Start the Services Locally” and removing the “without Docker”
wording.
- Around line 38-48: Update the environment-variable examples in the
installation documentation to quote every cloud placeholder containing angle
brackets, including the Neo4j, MongoDB, and PostgreSQL values. Add a brief
instruction that users must replace each quoted placeholder with their actual
connection details.
- Around line 64-70: Update the Windows PowerShell installation steps after
copying env.template.ps1 and before sourcing .env.ps1 to instruct users to edit
the file and populate the required database and service configuration values.
Keep the subsequent sourcing, build, and execution commands unchanged.
- Around line 8-10: Update the Ballerina version in
docs/docs/getting_started/installation.md at lines 8-10 from 2201.13.4 to
2201.11.0. The corresponding sections in opengin/ingestion-api/README.md lines
3-9 and opengin/read-api/README.md lines 3-9 already match and require no direct
changes.
- Around line 35-48: Update the cloud database setup instructions to include
non-empty MONGO_DB_NAME and MONGO_COLLECTION values and an explicit
POSTGRES_SSL_MODE setting, using require where the provider mandates it. Reorder
the installation steps so users copy the environment template before editing and
applying these cloud connection values, ensuring the later setup step does not
overwrite their changes.
In `@opengin/core-api/env.template.ps1`:
- Around line 7-21: Update the Neo4j configuration blocks in env.template.ps1 so
the default local assignments for NEO4J_URI, NEO4J_USER, and NEO4J_PASSWORD are
commented out, preventing them from overriding uncommented development or
testing values while preserving the existing local-testing options.
In `@opengin/core-api/README.md`:
- Around line 38-47: Update the Windows PowerShell setup sequence in the README
to build core-service.exe before invoking it. Add the project’s existing build
command between the go test command and .\core-service.exe, preserving the
current test and launch steps.
In `@opengin/ingestion-api/env.template.ps1`:
- Around line 1-11: Make the two configuration formats in env.template.ps1
mutually selectable: keep the development variables active by default and
comment out the deployment assignments, including CORE_SERVICE_URL and
INGESTION_SERVICE_URL, so PowerShell does not overwrite the development
configuration; retain clear comments indicating how to enable the deployment
block.
In `@opengin/ingestion-api/README.md`:
- Around line 72-75: Make the service-start commands use a consistent
working-directory convention: in opengin/ingestion-api/README.md lines 72-75 and
opengin/read-api/README.md lines 72-75, run the CORE command from the repository
root or use paths relative to the current directory; in
opengin/ingestion-api/README.md lines 97-98 and opengin/read-api/README.md lines
97-98, remove the duplicate directory change or reset to the repository root
before starting the service.
In `@opengin/read-api/env.template.ps1`:
- Around line 1-7: Update CORE_SERVICE_URL in the environment template to use a
reachable local or deployed Core hostname instead of 0.0.0.0, and remove
READ_SERVICE_URL because read-api does not consume it.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: ba5b6f31-85fb-4962-9e73-1240a9a25a60
📒 Files selected for processing (7)
docs/docs/getting_started/installation.mdopengin/core-api/README.mdopengin/core-api/env.template.ps1opengin/ingestion-api/README.mdopengin/ingestion-api/env.template.ps1opengin/read-api/README.mdopengin/read-api/env.template.ps1
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR closes #488
This PR Adds documentation to setup OpenGIN in a windows environment by adding the relevant env files and commands to execute them.
And also steps to setup cloud databases instead of docker containers and to run OpenGIN locally
Summary by CodeRabbit