Skip to content

Conversation

@d-bytebase
Copy link
Contributor

Summary

  • Removed outdated Docker and WebSocket requirements sections
  • Removed redundant reference sections that just link to other docs
  • Cleaned up FAQ to focus on actual frequently asked questions

Changes

  • Removed Docker version requirement (>= 20.10.24)
  • Removed WebSocket configuration note
  • Removed "Production Setup" reference section
  • Removed "Supported databases and versions" reference section
  • Removed "Supported VCS and providers" reference section
  • Removed "How to enable HTTPS" section
  • Removed "Post action webhook" section

These sections were either outdated or simply pointed to other documentation pages without providing actual FAQ content.

🤖 Generated with Claude Code

Remove the following sections that are no longer needed:
- Docker version requirements
- WebSocket configuration
- Production setup reference
- Supported databases reference
- VCS providers reference
- HTTPS enabling instructions
- Post-action webhook support

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

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

vercel bot commented Aug 11, 2025

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

Name Status Preview Comments Updated (UTC)
bytebase-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 11, 2025 4:44am

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 cleans up the FAQ documentation by removing outdated and redundant sections that don't provide actual FAQ value. The changes focus on eliminating sections that were either technically outdated or simply redirected users to other documentation pages.

  • Removed outdated technical requirements (Docker version, WebSocket configuration)
  • Eliminated reference-only sections that pointed to other documentation
  • Streamlined FAQ to contain only genuine frequently asked questions

@github-actions
Copy link

github-actions bot commented Aug 11, 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

Remove "Which data does Bytebase collect?" section as requested

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

Co-Authored-By: Claude <[email protected]>
Remove detailed subsections about database credentials, schema, and row data storage

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

Co-Authored-By: Claude <[email protected]>
Remove "How to enable debug mode" section including startup and runtime toggle instructions

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

Co-Authored-By: Claude <[email protected]>
Remove "Does Bytebase retain your data" section

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

Co-Authored-By: Claude <[email protected]>
@d-bytebase d-bytebase merged commit a4c195e into main Aug 11, 2025
4 of 5 checks passed
@d-bytebase d-bytebase deleted the cleanup-faq-sections branch August 11, 2025 04:42
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