Skip to content

Conversation

@d-bytebase
Copy link
Contributor

Summary

  • Remove documentation for deprecated command-line flags that are no longer supported
  • Update related documentation to reflect current behavior

Changes

  • Removed flags from documentation:

    • --disable-sample: Sample instances are now controlled via onboarding choices
    • --disable-metric: Metrics collection is now controlled via workspace settings
    • --demo: Demo mode flag no longer supported
    • --pg: External PostgreSQL configuration now handled differently
  • Updated documentation:

    • Security page: Clarified that metrics collection can be disabled in workspace settings
    • Add instance tutorial: Clarified sample instances only start when chosen during onboarding
    • Kubernetes deployment: Removed --disable-sample from example YAML
    • Command-line reference: Cleaned up formatting and removed redundant content

Test plan

  • Reviewed all documentation changes
  • Verified no broken links to removed flag sections
  • Ensured historical changelogs remain intact

🤖 Generated with Claude Code

- Remove --disable-sample and --disable-metric flags from docs
- Remove --demo flag documentation
- Remove --pg flag documentation
- Update security page to reflect workspace settings for metrics
- Clarify sample instances only start when chosen during onboarding
- Clean up command-line reference formatting

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copilot AI review requested due to automatic review settings August 12, 2025 09:03
@vercel
Copy link

vercel bot commented Aug 12, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
bytebase-com Ready Preview 💬 Add feedback Aug 12, 2025 9:08am

This comment was marked as outdated.

@github-actions
Copy link

github-actions bot commented Aug 12, 2025

📝 Broken Links Check Report

Note: Entries under /api-reference/ are likely false positives and can be ignored.

The following is the output from the broken links check:

found 16 broken links in 9 files

integrations/api/audit-log.mdx
 ⎿  /api-reference/auditlogservice/post-v1auditlogs:search

integrations/api/authentication.mdx
 ⎿  /api-reference/authservice/post-v1authlogin

integrations/api/data-classification.mdx
 ⎿  /api-reference/settingservice/patch-v1settings
 ⎿  /api-reference/databaseservice/patch-v1instances-databases

integrations/api/issue.mdx
 ⎿  /api-reference/issueservice/post-v1projects-issues

integrations/api/permission.mdx
 ⎿  /api-reference/workspaceservice/get-v1workspaces-:getIamPolicy
 ⎿  /api-reference/projectservice/get-v1projects-:getIamPolicy
 ⎿  /api-reference/roleservice/get-v1roles
 ⎿  /api-reference/userservice/get-v1users
 ⎿  /api-reference/groupservice/get-v1groups

integrations/api/plan.mdx
 ⎿  /api-reference/planservice/post-v1projects-plans
 ⎿  /api-reference/sheetservice/post-v1projects-sheets

integrations/api/release.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases

integrations/api/rollout.mdx
 ⎿  /api-reference/rolloutservice/post-v1projects-rollouts

integrations/api/sql-review.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases:check
 ⎿  /api-reference/sqlservice/post-v1sqlcheck

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes documentation for deprecated command-line flags that are no longer supported in Bytebase, updating references to reflect current behavior where these features are now controlled through UI settings or onboarding choices.

  • Removed documentation for --disable-sample, --disable-metric, --demo, and --pg flags
  • Updated references to clarify current configuration methods (workspace settings, onboarding choices)
  • Cleaned up command-line reference formatting and removed outdated examples

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
src/app/[locale]/(legal)/security/page.tsx Updated metrics collection reference to mention workspace settings instead of deprecated flag
mintlify/reference/command-line.mdx Removed deprecated flags documentation and reformatted remaining options
mintlify/get-started/step-by-step/add-an-instance.mdx Updated sample instance documentation to reflect onboarding-based control
mintlify/get-started/self-host/deploy-with-kubernetes.mdx Removed deprecated --disable-sample flag from Kubernetes example

@d-bytebase d-bytebase enabled auto-merge (squash) August 12, 2025 09:05
@d-bytebase d-bytebase merged commit f354ce7 into main Aug 12, 2025
4 of 5 checks passed
@d-bytebase d-bytebase deleted the remove-deprecated-flags branch August 12, 2025 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants