docs: add faqs from sharkymark #11168
Merged
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
matifali
approved these changes
Dec 13, 2023
docs/faqs.md
Outdated
| A good troubleshooting tip is to just disable STUN, Direct connections, and even | ||
| forcing websockets versus the embedded Tailscale DERP relay server. | ||
|
|
||
| If using a `systemd` configuration of Coder's control plane, add these values to |
There was a problem hiding this comment.
What do you think about just giving the flag names and values without detailing various ways to set these. We can link to the configuration page for that if required. FAQs are usually brief.
There was a problem hiding this comment.
Consolidated as table:
| Flag | Value | Meaning |
|---|---|---|
CODER_BLOCK_DIRECT |
true |
Blocks direct connections |
CODER_DERP_SERVER_STUN_ADDRESSES |
"disable" |
Disables STUN |
CODER_DERP_FORCE_WEBSOCKETS |
true |
Forces websockets over Tailscale DERP |
matifali
approved these changes
Dec 13, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Overview
We need a top-level page in our docs to add common FAQs from customers and community members. These previously existed in @sharkymark's v2-templates repository. This PR migrates them to our official docs under a new "FAQs" tab.
I cleaned up some of the informal text to match the tone of our docs.
The formatting and content changes are minimal, open to feedback.