docs: update ngrok usage, emphasize it's for testing purpose only #932
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the GitOps documentation to clarify that ngrok is only for local testing, while promoting Bytebase Cloud or self-hosted instances for production use. The changes improve user guidance by distinguishing between production and testing scenarios.
Key changes:
- Prerequisites updated to specify Bytebase Cloud/self-hosted as primary options with ngrok as optional for local testing
- Step titles changed from "Start Bytebase with ngrok" to "Set up Bytebase Instance" to be more general
- BYTEBASE_URL descriptions enhanced with production examples alongside ngrok testing scenarios
- ngrok snippet file updated with production warnings and clearer setup instructions
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| mintlify/tutorials/gitops-gitlab-workflow.mdx | Updates prerequisites and configuration guidance to distinguish production from testing setups |
| mintlify/tutorials/gitops-github-workflow.mdx | Updates prerequisites and configuration guidance to distinguish production from testing setups |
| mintlify/tutorials/gitops-bitbucket-workflow.mdx | Updates prerequisites and configuration guidance to distinguish production from testing setups |
| mintlify/tutorials/gitops-azure-devops-workflow.mdx | Updates prerequisites and configuration guidance to distinguish production from testing setups |
| mintlify/snippets/install/start-with-ngrok.mdx | Adds production warning and clarifies ngrok is for local testing only |
| mintlify/gitops/installation.mdx | Adds new section for local testing with ngrok, includes production warning |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
boojack
reviewed
Nov 7, 2025
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
adela-bytebase
force-pushed
the
a-branch-90
branch
from
b0958ab to
9528ecc
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
boojack
approved these changes
Nov 14, 2025
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.