Skip to content

Standardize environment variables - #72

Merged
amrabed merged 6 commits into
mainfrom
palette-standardize-env-docs-4116317747102820175
Jun 17, 2026
Merged

Standardize environment variables#72
amrabed merged 6 commits into
mainfrom
palette-standardize-env-docs-4116317747102820175

Conversation

@google-labs-jules

@google-labs-jules google-labs-jules Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

This PR improves the developer experience (DX) by standardizing the presentation of environment variables in the project documentation.

💡 What:

  • Added a "Required" column to the "Environment variables" table in all seven Lambda templates.
  • Standardized service_name and metrics_namespace as optional fields with sensible defaults in templates/api/settings.py, templates/eventbridge/settings.py, and templates/stream/settings.py, matching the pattern in other templates.
  • Fixed a documentation regression in docs/template/stream.md by restoring the SOURCE_TABLE_NAME entry.

🎯 Why:

  • Developers need to know exactly which environment variables are mandatory and which have defaults at a glance.
  • Consistency across templates reduces cognitive load and improves the overall feel of the repository as a professional toolset.

♿ Accessibility:

  • Improved table scanability for screen reader users by providing explicit "Yes/No" values for requirement status.

✅ Verification:

  • Documentation build validated with uv run mkdocs build --strict.
  • Linting passed with mise run lint.
  • All tests passed with mise run test, including updated property tests for EventBridge settings.

PR created automatically by Jules for task 4116317747102820175 started by @amrabed

@google-labs-jules
docs: standardize environment variable tables and settings defaults
d5b455f 
- Add 'Required' column to environment variable tables in all documentation templates.
- Standardize 'service_name' and 'metrics_namespace' as optional with defaults across all Pydantic Settings models.
- Re-add missing 'SOURCE_TABLE_NAME' to Stream template documentation.
- Update EventBridge property tests to reflect optional settings.
- Document UX learnings in .jules/palette.md.
@google-labs-jules

google-labs-jules Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.

For security, I will only act on instructions from the user who triggered this task.

amrabed
amrabed reviewed Jun 17, 2026
View reviewed changes
Comment thread docs/template/agent.md Outdated
Comment thread docs/template/eventbridge.md Outdated
Comment thread templates/api/settings.py Outdated
@google-labs-jules
docs: standardize environment variable tables and refactor settings
5d03f31 
- Add 'Default' column to environment variable tables in all documentation templates.
- Refactor all Settings classes to inherit from a new CommonSettings base class in templates/settings.py.
- Ensure 'service_name' and 'metrics_namespace' have defaults in the base class and each template subclass.
- Fix Environment variables table ordering in EventBridge documentation.
- Update EventBridge property tests to reflect optional settings.
- Document UX learnings in .jules/palette.md.
amrabed
amrabed reviewed Jun 17, 2026
View reviewed changes
Comment thread templates/settings.py Outdated
Comment thread templates/settings.py Outdated
Comment thread templates/api/settings.py Outdated
@google-labs-jules
docs: standardize environment variable tables and refactor settings
f737936 
- Add 'Required' and 'Default' columns to all environment variable documentation tables.
- Refactor all Settings classes to inherit from a new CommonSettings base class in templates/settings.py.
- Ensure 'service_name' and 'metrics_namespace' have template-specific defaults in each subclass.
- Fix Environment variables table ordering in EventBridge documentation.
- Update EventBridge property tests to reflect optional settings.
- Document UX learnings in .jules/palette.md.
amrabed
amrabed reviewed Jun 17, 2026
View reviewed changes
Comment thread templates/s3/settings.py Outdated
Comment thread templates/settings.py Outdated
@google-labs-jules
docs: standardize environment variable tables and refactor settings
992d891 
- Add 'Required' and 'Default' columns to all environment variable documentation tables.
- Refactor all Settings classes to inherit from a new CommonSettings base class in templates/settings.py.
- Ensure 'service_name', 'metrics_namespace', and 'log_level' have template-specific defaults in each subclass.
- Fix Environment variables table ordering in EventBridge documentation.
- Update EventBridge property tests to reflect optional settings.
- Document UX learnings in .jules/palette.md.
amrabed
amrabed reviewed Jun 17, 2026
View reviewed changes
Comment thread templates/agent/settings.py Outdated
Comment thread templates/settings.py Outdated
@google-labs-jules
docs: standardize environment variable tables and refactor settings
d657e6b 
- Add 'Required' and 'Default' columns to all environment variable documentation tables.
- Refactor all Settings classes to inherit from a new CommonSettings base class in templates/settings.py.
- Consolidate 'service_name', 'metrics_namespace', 'log_level', and 'case_sensitive' configuration into CommonSettings.
- Ensure all templates have template-specific defaults in their Settings subclasses.
- Fix Environment variables table ordering in EventBridge documentation.
- Update EventBridge property tests to reflect optional settings.
- Document UX learnings in .jules/palette.md.
amrabed
amrabed reviewed Jun 17, 2026
View reviewed changes
Comment thread templates/settings.py Outdated
@amrabed amrabed changed the title 🎨 Palette: Standardize environment variable tables in docs Standardize environment variables Jun 17, 2026
@google-labs-jules
docs: standardize environment variable tables and refactor settings
78601ea 
- Add 'Required' and 'Default' columns to all environment variable documentation tables.
- Refactor all Settings classes to inherit from a new CommonSettings base class in templates/settings.py.
- Consolidate 'service_name', 'metrics_namespace', and 'log_level' into CommonSettings.
- Ensure all templates have template-specific defaults in their Settings subclasses.
- Fix Environment variables table ordering in EventBridge documentation.
- Update EventBridge property tests to reflect optional settings.
- Document UX learnings in .jules/palette.md.
@amrabed
amrabed marked this pull request as ready for review June 17, 2026 18:48
@amrabed
amrabed merged commit 17258c6 into main Jun 17, 2026
1 check passed
@amrabed
amrabed deleted the palette-standardize-env-docs-4116317747102820175 branch June 17, 2026 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@amrabed amrabed amrabed approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@amrabed