Repository navigation
docs: list every pdt setting on one page - #304
autoidm-jon wants to merge 5 commits into
Conversation
Code review of
|
| # | Severity | Disposition | Finding | Action |
|---|---|---|---|---|
| R1 | should-fix | ✅ Fixed | docs/settings.md:113, :128: the AWS profile and Azure subscription defaults said pdt asks. AWS uses the SDK's default sign-in, and Azure takes the active CLI subscription. |
The rows now give the real defaults and say when pdt asks. |
| R2 | should-fix | ✅ Fixed | docs/settings.md:361: "It sends no project path" was wrong; a path typed on the command line stays in the sent command line, and only the home folder becomes ~. |
The section now says this, with an example. |
| R3 | should-fix | ✅ Fixed | docs/settings.md:355, :388: PDT_INSTALLATION_DIR names the parent of registrations/, not that folder. |
Both places now give <PDT_INSTALLATION_DIR>/registrations. |
| R4 | should-fix | ✅ Fixed | docs/settings.md:433: PDT_AZURE_STORAGE_ACCOUNT does not select the storage account; storage uses pdtdata<subscription hash>. |
Row removed. |
| R5 | should-fix | ✅ Fixed | docs/settings.md:415: the AWS credentials row missed AWS_SESSION_TOKEN, which a temporary key needs. |
Added. |
| R6 | should-fix | ✅ Fixed | docs/settings.md:240: a <NAME>_B64 value passes validation for a required <NAME>_PATH, but a deploy sends it only when config.yml lists it. |
The page says to list it, for example under optional. |
| R7 | should-fix | ✅ Fixed | docs/settings.md:395: on macOS the estimate currency comes from AppleLocale, not LC_ALL or LANG. |
The row now limits the variables to Linux and names the macOS and Windows sources. |
| R8 | should-fix | ✅ Fixed | docs/settings.md:183: pdt destroy also accepts a disabled app that is still deployed. |
Added. |
| R9 | nit | ✅ Fixed | The page missed CLOUDSDK_PYTHON, CLOUDSDK_COMPONENT_MANAGER_DISABLE_UPDATE_CHECK, and CLOUDSDK_SURVEY_DISABLE_PROMPTS, whose user values pdt keeps. |
Added. |
| R10 | nit | ✅ Fixed | docs/settings.md:523: a missing PDT_USAGE_JOB does not stop a job from sending statistics. |
The row now names the values that decide it. |
Checks that passed:
- Every top-level,
platform:, and app key in the code has an entry. - The README link works, and the prose is not hard-wrapped.
- No entry tells a user to set a value that only pdt sets for itself.
Code review of
|
| # | Severity | Disposition | Finding | Action |
|---|---|---|---|---|
| N1 | should-fix | ✅ Fixed | docs/settings.md:240: "A deploy sends only the names in config.yml" is wrong. A deploy also sends the env vars of the app's pdt.yml entry, the ones pdt finds in the code, and the ones the alert settings need. |
The sentence now names all of them, and still says to list a <NAME>_B64 that you set yourself. |
| N2 | should-fix | ✅ Fixed | docs/settings.md:128: "The first deploy saves it" is true only at a terminal. A deploy with no one to ask (CI) uses the active subscription and does not save it, and it stops instead of opening the browser login. |
The row now says both. |
Checks that passed:
- AWS signs in with the SDK's default credentials before it chooses a profile, and Azure uses the active CLI subscription.
- A path typed on the command line stays in the usage statistics, and only the home folder becomes
~. PDT_INSTALLATION_DIRnames the parent ofregistrations.- The Azure storage account row is gone, and storage uses
pdtdata<subscription hash>. AWS_SESSION_TOKEN, the threeCLOUDSDK_*variables, thepdt destroyexception for a disabled app, the currency source per operating system, and thePDT_USAGE_JOBrow match the code.
76a6c54 to
5e265c0
Compare
9c1a6c8 to
cbdebae
Compare
cbdebae to
ed8e460
Compare
|
Goal: users get a single docs page that describes each pdt setting, its values, and its default. The settings page linked to the
Findings 1 and 2 came from the user. Findings 3 and 4 came from the review. The branch is rebased onto the new head of Checks that passed:
Reviewer: Cursor |
A new page,
docs/settings.md, lists everypdt.ymlandconfig.ymlkey and every env var a user may set, with its allowed values and its default, including the usage statistics,managed_services, andpdt registersettings. The README links to it.Stacked on #300