-
Notifications
You must be signed in to change notification settings - Fork 39
docs(lstk hotfix): update CLI reference to v1.0.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
Merged
Merged
Changes from all commits
Commits
Show all changes
12 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 db9a277
docs(lstk): fix Docker Compose FAQ to point at --endpoint-url
gtsiolis a879299
docs(lstk): move Global options table to the Overview page
quetzalliwrites c7e7722
docs(lstk): apply reviewer wording to Docker Compose FAQ (lstk stop)
gtsiolis 8f5dee6
docs(lstk): remove em dash from Global options cross-reference
quetzalliwrites dbffaa1
Merge remote-tracking branch 'origin/claude/hopeful-babbage-21z8t2' i…
quetzalliwrites 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
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?
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.
Yes, @mmaureenliu, I've come up with a solution. Adding it in a new commit.
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 with both of you. Moved the "Global options" table to
index.mdx(the Overview page), right after Quick start. Reasoning: these flags apply to everyday interactive use (--config,--persist,--type,--snapshot, etc.), not just automation/CI, so the Overview page, the first thing every reader hits, is the right home. Left the CI-specific deep dives (Structured output, Targeting an external emulator) onautomation.mdx, cross-linked from the table.Since Azure (#909) and Snowflake (#910) are still open and haven't inherited this page split's IA yet, I'll carry this same placement into both before merging them, so all three product lines land consistent from day one rather than drifting and needing a follow-up fix later.
Pushed as
a879299f. Also retitled the PR tov1.0.0per the note below, since that's the current release tag and there's no CLI-surface delta fromv0.23.0.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.
The v1.0.0 retitle checks out — I verified the CLI surface directly:
v0.23.0..v1.0.0is only three commits, all release plumbing (.github/workflows/ci.yml,.goreleaser.yaml, and anupdate_test.gotiming fix), with nothing touched undercmd/,internal/, ordocs/. v1.0.0 is the major-version bump with no user-facing CLI change, so the reference content here stands accurate as-is for v1.0.0 — no further doc edits needed for the release.The Global-options →
index.mdxmove reads well, and both it and the earlier Docker Compose FAQ fix build green on Cloudflare Pages. Carrying the same placement into the Azure (#909) and Snowflake (#910) restructures sounds right.One bookkeeping note: the tracking ticket (DOC-433) still reads v0.23.0 — it should track v1.0.0 to match the retitle. I can't update Linear from here right now (the connector needs re-authorization), so flagging it so it isn't missed.
Generated by Claude Code