Skip to content

Commit a4c195e

Browse files
d-bytebaseclaude
andauthored
Remove outdated sections from FAQ (#794)
* docs: remove outdated sections from FAQ 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]> * docs: remove data collection section from FAQ Remove "Which data does Bytebase collect?" section as requested 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * docs: remove database data retention subsections from FAQ 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]> * docs: remove debug mode section from FAQ 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]> * docs: remove data retention section from FAQ Remove "Does Bytebase retain your data" section 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent b4bfc81 commit a4c195e

File tree

1 file changed

+0
-73
lines changed

1 file changed

+0
-73
lines changed

mintlify/faq.mdx

Lines changed: 0 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -39,82 +39,9 @@ then you need to reserve large disk space. A good starting point is to reserve 1
3939
the Bytebase server runs. And if you use [External PostgreSQL](/get-started/self-host/external-postgres/),
4040
then you need to make sure to reserve enough space there.
4141

42-
### Docker
4342

44-
If you use Docker to deploy Bytebase, please use Docker version >= [20.10.24](https://docs.docker.com/engine/release-notes/20.10/).
4543

46-
### WebSocket
4744

48-
SQL Editor autocomplete requires [enabling WebSocket](/get-started/self-host/external-access#websocket-support) in your gateway if present.
4945

50-
## Does Bytebase retain your data
5146

52-
Bytebase does not retain any database row data.
5347

54-
### Database credentials
55-
56-
In order to perform database operations on users' behalf, Bytebase needs users to provide the database credentials.
57-
By default, Bytebase stores the supplied credentials in the obfuscated format. For the Enterprise plan, you can
58-
instruct Bytebase to [use the external secret manager](/get-started/instance/#use-secret-manager).
59-
60-
### Database schema (metadata)
61-
62-
Bytebase syncs and stores the database schema information. If you enable [AI Assistant](/ai-assistant/),
63-
Bytebase will also send the schema info to OpenAI or the configured endpoint.
64-
65-
### Database data (row data)
66-
67-
When you query the database via Bytebase, Bytebase does not store the result data. [Audit log](/security/audit-log/)
68-
only records the query.
69-
70-
If you enable [Data Rollback](/change-database/rollback-data-changes/), Bytebase will store the backup data in your
71-
own database instance.
72-
73-
## Production Setup
74-
75-
See [Production Setup](/get-started/self-host/production-setup/).
76-
77-
## Supported database and versions
78-
79-
See [Supported Databases](/introduction/supported-databases).
80-
81-
## Supported version control systems (VCS) and providers
82-
83-
See [GitOps](/vcs-integration/overview).
84-
85-
## How to enable https
86-
87-
You can use [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) or [Nginx](https://www.nginx.com/).
88-
89-
## How to enable debug mode
90-
91-
<Note>
92-
93-
Debug mode is a global setting and is only supposed to be used for troubleshooting.
94-
95-
</Note>
96-
97-
Debug mode emits more detailed logs on the backend as well as returning more verbose logs to the frontend.
98-
99-
### Enable `--debug` on startup
100-
101-
You can pass [`--debug`](/reference/command-line#--debug) when starting Bytebase.
102-
103-
### Toggle debug mode at runtime
104-
105-
If you are an OWNER or DBA, you can also toggle debug mode at runtime. The toggle is under the top-right profile dropdown
106-
107-
<p align="center">
108-
<img src="/content/docs/FAQ/troubleshoot-debug-mode.webp" width="50%" />
109-
</p>
110-
111-
## Does Bytebase support post action after applying a change to the database
112-
113-
You can configure [project webhook](/change-database/webhook/#supported-webhook-endpoints) to observe events.
114-
115-
## Which data does Bytebase collect?
116-
117-
_To make deployment air-gapped, you can disable the collection by passing [`--disable-metric`](/reference/command-line/#disable-sample) on startup_.
118-
119-
- Anonymous usage data.
120-
- The registered email and name of the first member in the workspace.

0 commit comments

Comments
 (0)