docgen: add generator for all defined settings#23531
Conversation
|
This change is |
|
@benesch I'm not quite sure where it makes sense -- if it makes sense -- to add to makefile since this depends on ~everything, but I'd certainly want it run on an explicit |
jseldess
left a comment
There was a problem hiding this comment.
This is a great, @dt! Just a few questions/comments. Also, in our current cluster settings doc, we have a warning:
Many cluster settings are intended for tuning CockroachDB internals. Before changing these settings, we strongly encourage you to discuss your goals with Cockroach Labs; otherwise, you use them at your own risk.
And we then list only the settings that customers can safely change without consulting us. Do you think it's time for us to change this approach and just embed all settings on that page?
pkg/sqlmigrations/migrations.go
Outdated
| return err | ||
| } | ||
|
|
||
| // SettingsDefaultOverrides documents the effect of several migrations add an |
There was a problem hiding this comment.
I can't figure out what several migrations add an explicit value... is trying to say.
There was a problem hiding this comment.
was missing a that. Fixed.
docs/generated/settings/settings.md
Outdated
| @@ -0,0 +1,52 @@ | |||
| | SETTING | TYPE | DEFAULT | DESCRIPTION | | |||
| |---------------------------------------------------|-------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------| | |||
| | cloudstorage.gs.default.key | string | | if set, JSON key to use during Google Cloud Storage operations | | |||
There was a problem hiding this comment.
Do you think we should put backticks around the settings, types, and defaults?
| `debug.panic_on_failed_assertions` | `boolean` | `false` | panic when an assertion fails rather than reporting |
There was a problem hiding this comment.
Done for name and value, type doesn't seem like a literal?
| return v, ok | ||
| } | ||
|
|
||
| // ReadableTypes maps our short type identifiers to friendlier names. |
Release note: none.
|
We hide some settings from |
|
Can we get a followup PR to add a docgen rule for this so it stays in sync? |
The settings we want to keep hidden are also hidden from the auto-generated table, according to the discussion at cockroachdb/cockroach#23531
The settings we want to keep hidden are also hidden from the auto-generated table, according to the discussion at cockroachdb/cockroach#23531
Release note: none.