From bfab312bb322e5751f4cacd824b507f926635851 Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Wed, 2 Nov 2022 14:22:29 -0700 Subject: [PATCH] Add an FAQ to docs (#1428) ## Description Covers some questions that have come up in initial user testing ## Type of change - [x] :world_map: Documentation ## Test Plan - [x] :muscle: Manual --- docs/.markdownlint.json | 4 +++- docs/docs/support/faq.md | 22 ++++++++++++++++++++++ docs/sidebars.js | 2 +- 3 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 docs/docs/support/faq.md diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json index 29798eb90..0a20cf4ef 100644 --- a/docs/.markdownlint.json +++ b/docs/.markdownlint.json @@ -11,7 +11,9 @@ "Tabs", "TabItem", "CodeBlock", - "DownloadBinaries" + "DownloadBinaries", + "details", + "summary" ] }, } diff --git a/docs/docs/support/faq.md b/docs/docs/support/faq.md new file mode 100644 index 000000000..f38203e9b --- /dev/null +++ b/docs/docs/support/faq.md @@ -0,0 +1,22 @@ +# FAQ + +
+ Where does Corso store local configuration? + +Corso's local configuration is stored in a file named `.corso.toml` in your home directory. Corso can be pointed at +separate configuration files using the `--config-file` option. + +
+ +
+ Does Corso report usage telemetry? + +In order to better understand how people use Corso and to guide feature development, Corso supports reporting telemetry +metadata for basic information about installed versions and usage in a privacy-preserving manner. This includes a +generic description of most-commonly used backup operations and statistics on the duration and size of backups. No user +data is stored or transmitted during this process. + +Telemetry reporting can be turned off by using the `--no-stats` flag. See the [Command Line Reference](cli/corso) +section for more information. + +
diff --git a/docs/sidebars.js b/docs/sidebars.js index cadd4fe7b..05c30f2d7 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -42,7 +42,7 @@ const sidebars = { type: 'category', label: 'Support', items: [ - 'support/bugs_and_features', 'support/known_issues' + 'support/bugs_and_features', 'support/known_issues', 'support/faq' ], }, {