Custom Columns docs #1219
Custom Columns docs #1219
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1219 +/- ##
=======================================
Coverage 35.27% 35.27%
=======================================
Files 232 232
Lines 25185 25185
=======================================
Hits 8885 8885
Misses 15036 15036
Partials 1264 1264
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
📝 WalkthroughWalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
User->>Atmos CLI: Run `atmos list <command>`
Atmos CLI->>atmos.yaml: Read column customization config
atmos.yaml-->>Atmos CLI: Return columns and templates
Atmos CLI->>Atmos CLI: Render output using templates
Atmos CLI-->>User: Display customized output table
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (8)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
website/docs/cli/commands/list/custom-columns.mdx (2)
1-1: Format the title to highlight CLI syntax.Consider updating the title to use code formatting for the CLI command and lowercase
atmos:- # Customizing Columns in Atmos List Commands + # Customizing Columns in `atmos list` Commands
170-170: Refine language for stronger tone.Consider replacing "very wide tables" with "excessively wide tables" to avoid a weak intensifier:
- For very wide tables, use the `--max-columns` flag (default: 10 or 50, depending on command) or reduce the number of columns in your config. + For excessively wide tables, use the `--max-columns` flag (default: 10 or 50, depending on command) or reduce the number of columns in your config.🧰 Tools
🪛 LanguageTool
[style] ~170-~170: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... available fields for templating. - For very wide tables, use the--max-columnsflag (d...(EN_WEAK_ADJECTIVE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
website/docs/cli/commands/list/custom-columns.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
website/docs/cli/commands/list/custom-columns.mdx
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...s shown in the output table. - value: A Go template string that determines th...
(UNLIKELY_OPENING_PUNCTUATION)
[typographical] ~146-~146: Consider using a typographic opening quote here.
Context: ...idebar config file to include a link to "Customizing Columns in List Commands". ...
(EN_QUOTES)
[typographical] ~146-~146: Consider using a typographic close quote here.
Context: ...to "Customizing Columns in List Commands". --- ## Display Behavior ### TTY vs ...
(EN_QUOTES)
[typographical] ~152-~152: In American English, use a period after an abbreviation.
Context: ...ds". --- ## Display Behavior ### TTY vs Non-TTY Output - **TTY Output (Interac...
(MISSING_PERIOD_AFTER_ABBREVIATION)
[style] ~170-~170: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... available fields for templating. - For very wide tables, use the --max-columns flag (d...
(EN_WEAK_ADJECTIVE)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Acceptance Tests (windows-latest, windows)
- GitHub Check: Summary
🔇 Additional comments (6)
website/docs/cli/commands/list/custom-columns.mdx (6)
23-32: Looks good.The supported list commands are clearly enumerated with correct CLI syntax.
78-89: Example for stacks is clear and correct.The YAML snippet correctly demonstrates
stacks.list.columnsusing.stack_nameand.stack_path.
93-105: Components example is accurate.This snippet effectively illustrates custom columns for components, including
.component_path.
109-121: Workflows example is well-presented.The example demonstrates the use of
.workflow_name,.workflow_file, and.workflow_descriptionclearly.
125-139: Full reference section is comprehensive.The YAML reference snippet clearly outlines the required structure and optional fields.
150-165: Display behavior details are clear.This section effectively explains the differences between TTY and non-TTY outputs and default behaviors.
🧰 Tools
🪛 LanguageTool
[typographical] ~152-~152: In American English, use a period after an abbreviation.
Context: ...ds". --- ## Display Behavior ### TTY vs Non-TTY Output - **TTY Output (Interac...(MISSING_PERIOD_AFTER_ABBREVIATION)
|
Important Cloud Posse Engineering Team Review RequiredThis pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes. To expedite this process, reach out to us on Slack in the |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
website/docs/cli/commands/list/list-column-customization.mdx (4)
28-40: Supported commands list is comprehensive. Consider adding link anchors (#atmos-list-stacks, etc.) for each command to speed navigation in longer docs.
107-124: Stacks example is accurate. Suggest wrapping column headers in backticks (e.g.,Stack Name,Configuration Path) to align with code styling conventions.🧰 Tools
🪛 LanguageTool
[typographical] ~123-~123: Consider using typographic quotation marks here.
Context: ...e output table will have columns titled "Stack Name" and "Configuration Path". --- ## Examp...(EN_QUOTES)
[typographical] ~123-~123: Consider using typographic quotation marks here.
Context: ...ll have columns titled "Stack Name" and "Configuration Path". --- ## Example: Custom Columns for Co...(EN_QUOTES)
164-180: Full reference section is solid. At line 179, consider rephrasing to avoid repeating “specifically” in adjacent sentences for better variation.🧰 Tools
🪛 LanguageTool
[style] ~179-~179: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...Thecolumnsarray is mandatory if you want to override the default columns. If `colum...(REP_WANT_TO_VB)
202-210: Troubleshooting & Tips is useful. In the second bullet (line 205), add an Oxford comma before “or”:- if the table is too wide for your terminal or you encounter errors about content width: + if the table is too wide for your terminal, or you encounter errors about content width:🧰 Tools
🪛 LanguageTool
[uncategorized] ~205-~205: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... the table is too wide for your terminal or you encounter errors about content widt...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
website/docs/cli/commands/list/list-column-customization.mdx(1 hunks)website/docs/cli/commands/list/list-components.mdx(1 hunks)website/docs/cli/commands/list/list-metadata.mdx(1 hunks)website/docs/cli/commands/list/list-settings.mdx(1 hunks)website/docs/cli/commands/list/list-stacks.mdx(1 hunks)website/docs/cli/commands/list/list-values.mdx(1 hunks)website/docs/cli/commands/list/list-vars.mdx(1 hunks)website/docs/cli/commands/list/list-workflows.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (7)
- website/docs/cli/commands/list/list-components.mdx
- website/docs/cli/commands/list/list-workflows.mdx
- website/docs/cli/commands/list/list-settings.mdx
- website/docs/cli/commands/list/list-stacks.mdx
- website/docs/cli/commands/list/list-metadata.mdx
- website/docs/cli/commands/list/list-vars.mdx
- website/docs/cli/commands/list/list-values.mdx
🧰 Additional context used
🪛 LanguageTool
website/docs/cli/commands/list/list-column-customization.mdx
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...ar as the column header. * value: A Go template string that dynamically d...
(UNLIKELY_OPENING_PUNCTUATION)
[typographical] ~123-~123: Consider using typographic quotation marks here.
Context: ...e output table will have columns titled "Stack Name" and "Configuration Path". --- ## Examp...
(EN_QUOTES)
[typographical] ~123-~123: Consider using typographic quotation marks here.
Context: ...ll have columns titled "Stack Name" and "Configuration Path". --- ## Example: Custom Columns for Co...
(EN_QUOTES)
[style] ~179-~179: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...The columns array is mandatory if you want to override the default columns. If `colum...
(REP_WANT_TO_VB)
[typographical] ~185-~185: In American English, use a period after an abbreviation.
Context: ...mns. --- ## Display Behavior ### TTY vs Non-TTY Output The appearance of the o...
(MISSING_PERIOD_AFTER_ABBREVIATION)
[uncategorized] ~205-~205: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... the table is too wide for your terminal or you encounter errors about content widt...
(COMMA_COMPOUND_SENTENCE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Analyze (go)
- GitHub Check: Lint (golangci)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Summary
🔇 Additional comments (10)
website/docs/cli/commands/list/list-column-customization.mdx (10)
1-4: Frontmatter setup looks correct and consistent. Title and sidebar label align with repo conventions.
6-13: Overview is clear and concise. Good introduction to the feature and where to configure it.
14-25: Table of Contents covers all key sections. Makes navigation straightforward.
44-53: How Column Customization Works section is well structured. The numbered steps are easy to follow.🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...ar as the column header. *value: A Go template string that dynamically d...(UNLIKELY_OPENING_PUNCTUATION)
54-67: Example YAML structure is clear. Demonstrates required fields and nesting neatly.
70-99: YAML Template Syntax reference is thorough. Listing available Go template variables per command makes it easy to craft custom columns.
101-105: Inline usage example is helpful. Shows the minimalvalue: "{{ .stack_name }}"use case.
126-143: Components example reads well. Clear mapping of template variables to headers.
145-162: Workflows example is spot on. Covers name, file, and description cleanly.
184-199: Display Behavior section covers TTY vs non-TTY clearly. Well explained with pros and cons.🧰 Tools
🪛 LanguageTool
[typographical] ~185-~185: In American English, use a period after an abbreviation.
Context: ...mns. --- ## Display Behavior ### TTY vs Non-TTY Output The appearance of the o...(MISSING_PERIOD_AFTER_ABBREVIATION)
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
website/docs/cli/commands/list/usage.mdx (6)
17-20: Streamline introductory paragraph
The first sentence is quite long; consider splitting it after “commands.” and starting a second sentence with “This lets you tailor the tabular output….” for improved readability.
26-37: Improve table readability
The descriptions in the Supported List Commands table are lengthy. You might wrap cell content or convert complex descriptions into bullet points to prevent horizontal scrolling on narrow viewports.
38-39: Remove redundant sentence
This line reiterates previously covered points. Consider removing it or merging with the intro to avoid duplication.
51-63: Specify code fence language
Please label the YAML example with a language identifier for syntax highlighting, e.g.:-``` +```yaml
137-146: Add missing period after “e.g.”
In the TTY output bullet, update “e.g” to “e.g.” for consistency:-**TTY Output (e.g running in your terminal)** +**TTY Output (e.g. running in your terminal)**🧰 Tools
🪛 LanguageTool
[typographical] ~137-~137: In American English, use a period after an abbreviation.
Context: ...ile. ::: ## Display Behavior ### TTY vs Non-TTY Output The appearance of the o...(MISSING_PERIOD_AFTER_ABBREVIATION)
151-160: Polish bullet punctuation
In the troubleshooting tips, add a comma before “or” in the “wide tables” item (“too wide for your terminal, or you encounter…”) and ensure list items end with consistent punctuation (periods).🧰 Tools
🪛 LanguageTool
[uncategorized] ~155-~155: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... the table is too wide for your terminal or you encounter errors about content widt...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
website/docs/cli/commands/list/usage.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
website/docs/cli/commands/list/usage.mdx
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...ar as the column header. * value: A Go template string that dynamically d...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~113-~113: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...The columns array is mandatory if you want to override the default columns. If `colum...
(REP_WANT_TO_VB)
[typographical] ~137-~137: In American English, use a period after an abbreviation.
Context: ...ile. ::: ## Display Behavior ### TTY vs Non-TTY Output The appearance of the o...
(MISSING_PERIOD_AFTER_ABBREVIATION)
[uncategorized] ~155-~155: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... the table is too wide for your terminal or you encounter errors about content widt...
(COMMA_COMPOUND_SENTENCE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (5)
website/docs/cli/commands/list/usage.mdx (5)
7-9: Review import statements
ImportingScreengrabandDocCardListlooks correct for embedding the screenshot and listing subcommands. Ensure theScreengrabcomponent path matches the actual location under@site/src/components/Screengrab.
41-50: Section is clear and concise
The “How Column Customization Works” steps are well structured and easy to follow. Great clarity here.🧰 Tools
🪛 LanguageTool
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...ar as the column header. *value: A Go template string that dynamically d...(UNLIKELY_OPENING_PUNCTUATION)
66-74: Template syntax section is solid
The explanation and examples of Go template variables per command are clear and correctly scoped. Nice work.
98-113: Full reference is comprehensive
The generalatmos.yamlstructure for custom list columns is well documented and complete. No issues here.🧰 Tools
🪛 LanguageTool
[style] ~113-~113: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...Thecolumnsarray is mandatory if you want to override the default columns. If `colum...(REP_WANT_TO_VB)
115-133: Workflow example looks good
The YAML snippet clearly demonstrates custom columns for workflows, and the note about{{ .file }}is helpful.
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
|
LGTM thanks for more docs |
what
atmos list custom columns documentation
why
We have multiple places using custom columns in atmos list but are missing documentation
references
Summary by CodeRabbit
atmos listcommands, including detailed configuration examples and troubleshooting tips.list components,list stacks,list workflows,list metadata,list settings,list values, andlist varscommands.