Skip to content

fix docs error on stores#1045

Merged
mcalhoun merged 2 commits intomainfrom
fix-docs-error
Feb 10, 2025
Merged

fix docs error on stores#1045
mcalhoun merged 2 commits intomainfrom
fix-docs-error

Conversation

@mcalhoun
Copy link
Contributor

@mcalhoun mcalhoun commented Feb 10, 2025 •
edited by coderabbitai bot
Loading

what

  • Documentation fixes for !store YAML function

why

  • Several references were missing the <store_name> part of the function call

Summary by CodeRabbit

  • Documentation
    • Updated YAML configuration guidelines to require an explicit store identifier as the first argument.
    • Revised usage examples and parameter descriptions for consistency and improved clarity in configuration.

@mcalhoun Graphite App
Copy link
Contributor Author

mcalhoun commented Feb 10, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@mergify
Copy link

mergify bot commented Feb 10, 2025

💥 This pull request now has conflicts. Could you fix it @mcalhoun? 🙏

@mergify mergify bot added conflict This PR has conflicts triage Needs triage labels Feb 10, 2025
@mcalhoun mcalhoun marked this pull request as ready for review February 10, 2025 17:55
@mcalhoun mcalhoun requested a review from a team as a code owner February 10, 2025 17:55
@mergify mergify bot removed the conflict This PR has conflicts label Feb 10, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 10, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

This pull request updates the documentation for the !store YAML function by modifying its parameter structure. The function now explicitly requires a new mandatory parameter, store_name, as the first argument. All usage examples and argument descriptions across the documentation have been revised to reflect this updated syntax as defined in the related configuration files.

Changes

File(s) Change Summary
website/docs/.../store.mdx Updated documentation for the !store function to include the mandatory store_name parameter; revised function signatures, usage examples, and argument descriptions.

Possibly related PRs

Suggested labels

no-release

Suggested reviewers

  • osterman
📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ccb55ec and 55f29df.

📒 Files selected for processing (1)
  • website/docs/core-concepts/stacks/yaml-functions/store.mdx (7 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Build (macos-latest, macos)
  • GitHub Check: Build (windows-latest, windows)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: website-deploy-preview
  • GitHub Check: Analyze (go)
  • GitHub Check: Summary
🔇 Additional comments (8)
website/docs/core-concepts/stacks/yaml-functions/store.mdx (8)

22-28: Update Function Usage Examples:
The usage examples have been updated to explicitly include <store_name> as the first parameter, which makes the syntax clear for both the two-parameter and three-parameter (with default value) cases. This change improves clarity and aligns well with the new function signature.

34-36: Clarify store_name Argument Documentation:
The added documentation for the <store_name> argument clearly explains its purpose and refers to its definition in the atmos.yaml file. This addition significantly improves understanding for the users.

66-68: Consistent Example Update in "stack.yaml":
The examples within the <File title="stack.yaml"> block now correctly show prod/ssm as the store name, followed by the component and key. This update is both consistent and instructive in demonstrating the new parameter order.

88-88: Hardcoded Stack Name Example Corrected:
The snippet for the hardcoded stack name now properly places prod/ssm as the store name, followed by the component, the explicit stack (plat-ue2-prod), and the key. This is an excellent and clear example of the new syntax.

97-99: Template Identifier Usage Updated:
The updated examples using .stack and .atmos_stack correctly include the <store_name> parameter at the beginning. This makes the usage in dynamic scenarios much easier to understand and follow.

108-108: Example Consistency with New Parameter Order:
The example that demonstrates retrieving the vpc_id using the {{ .stack }} template now correctly begins with prod/ssm, aligning with the overall new parameter structure.

122-127: Enhanced Format Function Examples:
The examples illustrating the use of printf to dynamically construct stack names now include <store_name> as the first parameter. This update not only provides clarity but also reinforces the newly required parameter across multiple usage scenarios.

146-146: Dynamic Stack Naming Example is Clear:
The example in the "plat-ue2-dev" section now uses prod/ssm correctly as the store name and employs printf to format the stack name dynamically. This change effectively demonstrates the intended usage and improves the overall documentation clarity.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary or @auto-summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@mergify mergify bot removed the triage Needs triage label Feb 10, 2025
@mcalhoun mcalhoun merged commit a8757da into main Feb 10, 2025
45 of 46 checks passed
@mcalhoun mcalhoun deleted the fix-docs-error branch February 10, 2025 18:15
@mcalhoun mcalhoun added the no-release Do not create a new release (wait for additional code changes) label Feb 10, 2025
@github-actions
Copy link

github-actions bot commented Feb 11, 2025

These changes were released in v1.160.4.

@coderabbitai coderabbitai bot mentioned this pull request Apr 4, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Apr 14, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Dec 12, 2025
Closed
@coderabbitai coderabbitai bot mentioned this pull request Feb 28, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

No one assigned

Labels

no-release Do not create a new release (wait for additional code changes)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@mcalhoun