Skip to content

docs: list every pdt setting on one page - #304

Draft
autoidm-jon wants to merge 5 commits into
feat/usage-statsfrom
docs/settings-reference
Draft

autoidm-jon wants to merge 5 commits into
feat/usage-statsfrom
docs/settings-reference

Conversation

@autoidm-jon

Copy link
Copy Markdown
Contributor

A new page, docs/settings.md, lists every pdt.yml and config.yml key and every env var a user may set, with its allowed values and its default, including the usage statistics, managed_services, and pdt register settings. The README links to it.

Stacked on #300

@autoidm-jon

autoidm-jon commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor Author

Code review of feat/usage-stats..782ff081, round 1

Goal: users get a single docs page that describes each pdt setting, its values, and its default.

Reviewer: Codex gpt-6.1-sol at xhigh. Checks on 782ff081: uv run pytest -q 2860 passed and 3 skipped, uv run --group dev ruff check passed. All fixes are in 57de9319.

# 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.

@autoidm-jon

autoidm-jon commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor Author

Code review of feat/usage-stats..57de9319, round 2

Goal: users get a single docs page that describes each pdt setting, its values, and its default.

Reviewer: Codex gpt-6.1-sol at xhigh. This round checks the fixes for round 1 (R1 to R10). R2, R3, R4, R5, R7, R8, R9, and R10 are closed. R1 and R6 are closed, but their new sentences added N1 and N2. The fixes for N1 and N2 are in 9c1a6c80, which this round did not review.

# 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_DIR names the parent of registrations.
  • The Azure storage account row is gone, and storage uses pdtdata<subscription hash>.
  • AWS_SESSION_TOKEN, the three CLOUDSDK_* variables, the pdt destroy exception for a disabled app, the currency source per operating system, and the PDT_USAGE_JOB row match the code.

@autoidm-jon
autoidm-jon force-pushed the feat/usage-stats branch 2 times, most recently from 76a6c54 to 5e265c0 Compare November 3, 2026 19:14
@autoidm-jon
autoidm-jon force-pushed the docs/settings-reference branch from 9c1a6c8 to cbdebae Compare November 3, 2026 19:18
@autoidm-jon
autoidm-jon force-pushed the docs/settings-reference branch from cbdebae to ed8e460 Compare November 3, 2026 19:52
@autoidm-jon

autoidm-jon commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor Author

Goal: users get a single docs page that describes each pdt setting, its values, and its default.

The settings page linked to the docs/projects.md section that PR 294 removed on request. The usage statistics text did not say what --yes does.

# Severity Disposition Finding Action
1 should-fix ✅ Fixed docs/settings.md:344 linked to projects.md#managed-services-from-autoidm, a section that no longer exists. ed8e460: the link is removed. The managed_services row of the top-level keys already says that pdt register writes the block.
2 should-fix ✅ Fixed The usage statistics text did not say what --yes does. ed8e460: --yes answers the question with yes, and each opt-out setting still turns the statistics off.
3 should-fix ✅ Fixed The new text read as if --yes always answers. In the code, -y also answers, and a --yes after pdt aws, pdt az, or pdt gcloud does not. 475f066: the text names -y and the cloud CLI exception.
4 should-fix ✅ Fixed "At a terminal, pdt asks once" did not name the flags that skip the question. 475f066: the text names --help, --version, --json, --plan, --names, and --script, and says that such a command sends nothing until you answer.

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 feat/usage-stats.

Checks that passed:

  • A link check of README.md and docs/*.md: 0 broken links and anchors. The same check finds the old link at the earlier head.
  • CI on 475f066: 10 of 10 checks passed.
  • The reviewer changed no file (git status --porcelain before and after).

Reviewer: Cursor gpt-5.6-luna-high.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant