-
Notifications
You must be signed in to change notification settings - Fork 39
docs(lstk hotfix): update CLI reference to v0.23.0
#912
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
gtsiolis
wants to merge
7
commits into
main
Choose a base branch
from
claude/hopeful-babbage-21z8t2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
fd84986
docs(lstk): update CLI reference to v0.22.2
gtsiolis da5d692
Fix inaccurate statement on aws --account
anisaoshafi c8ad05a
docs(lstk): fold in runtime discovery, port 443, checksum, account pl…
gtsiolis c6024d5
Merge remote-tracking branch 'origin/claude/hopeful-babbage-21z8t2' i…
gtsiolis 800fe40
docs(lstk): apply the same v0.22.2 corrections to the Azure lstk page
gtsiolis 610128e
docs(lstk): Azure does not support snapshots (only Snowflake is exper…
gtsiolis 64c9d0d
docs(lstk): document --json for start and status (v0.23.0)
gtsiolis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @peter-smith-phd do you want to take this opportunity to fix the first FAQ? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this belongs to the "Cloud and IaC Commands" section as this option is quite important for local dev use case. @peter-smith-phd what do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It lives in the global-options table because
--endpoint-urlis a persistent/global flag that applies across many commands (aws,az, the IaC tools,status,reset,snapshot), not just the IaC ones — and the full "Targeting an external emulator" section is right below it. I've also cross-referenced it from the Cloud & IaC page's intro note so it's discoverable from there. Happy to move the detailed section into Cloud & IaC (or duplicate a short callout there) if you and @peter-smith-phd prefer that placement — leaving this open for your call rather than restructuring unilaterally.Generated by Claude Code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree the
--endpoint-urlcan apply to multiple commands, not just IaC commands. Basically, anything that communicates with the emulator can use it (includingsnapshot,reset, etc).However, I don't understand why the global options are hidden down on the
automation.mdxpage. These apply for interactive use, not just for automation, and should be much sooner in the docs.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed on the scope — the docs already frame
--endpoint-urlas applying to any command that talks to the emulator (aws,az, the IaC tools,status,reset,snapshot), so nothing to change there.On placement: the "Global options" section living on the Automation & CI page is inherited from the multi-page split (#898), not something this PR introduced — this PR is a content-accuracy sync. You and Maureen are both pointing at the same thing from different angles: Maureen suggested moving it under Cloud & IaC, but your point that these are global and interactive-facing (not IaC-specific, not automation-specific) argues against burying them under either.
Concrete proposal: lift the "Global options" table to the reference landing page (
index.mdx) so it's the first thing a reader hits, and leave the detailed "Targeting an external emulator" section where it is (cross-referenced), mirroring the same move on the Azure page. That reshapes the split's IA and overlaps the Azure restructure (#909), so I'd rather not fold it into this sync PR unilaterally — happy to do it as a small follow-up, or add it here if you'd prefer it in one go. Your call; leaving this open.Generated by Claude Code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@quetzalliwrites are you able to find a better placing for these global options so they are easier to find and also obvious that they apply to all commands?