Repository navigation
Retire the LiteFS Cloud command pages - #2530
Merged
Merged
Conversation
Lillian removed these commands from flyctl on 8 September in superfly/flyctl#5187, with the note "this has been dead code for a long time". The LiteFS Cloud service itself was retired on 15 October 2024. The docs half never caught up, so docs.fly.io has been publishing flag references for eleven commands that are not in the binary. Deleted rather than annotated. The explanation already exists on litefs/cloud-backups, which carries the sunset warning and the community post, and nobody can act on a flag list for a command that does not run. Archiving in place, as the unmanaged Postgres guides were, suits a page that still has standalone value; this does not. The eleven redirects that pointed into these pages now point at litefs/cloud-backups, and the eleven /flyctl/cmd/ URLs are redirected there too, since they are live today and would otherwise 404. That is 615 redirects where there were 604. The increase is deliberate: the alternative is breaking URLs that work. LiteFS the project is not affected and its pages are untouched. The nav group and its nested clusters group are gone, with no dangling references left in docs.json.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
kcmartin
added a commit
to superfly/flyctl
that referenced
this pull request
Oct 8, 2026
* Restore --delete to the docs sync Left out of #5287 because the first sync would have removed 12 pages that docs.json nav and 15 redirects still pointed at. Those have landed: superfly/docs#2530 retired the litefs-cloud pages and #2535 the duplicate root page. Verified before restoring: generating from master and comparing against superfly/docs main gives identical page sets, 305 each, and zero changed pages. So --delete removes nothing today, and from now on a command removed from flyctl stops being documented. * Refuse to sync when the generator produced almost nothing Neither script uses set -e and out/ is cleared before generating, so a failed generator leaves out/ empty and the rsync, now with --delete, would remove every page. The review requirement would catch the resulting PR, but the script should not rely on that. A floor rather than set -e: set -e would abort the label-preservation loop, where [ -n "$label" ] && awk ... returns non-zero for the 270 pages that carry no sidebarTitle.
This branch was successfully deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
docs.fly.io currently publishes flag references for eleven
fly litefs-cloudcommands that are not in the binary. Lillian removed them from flyctl on 8 September in superfly/flyctl#5187, with the note "this has been dead code for a long time", and the LiteFS Cloud service itself was retired on 15 October 2024.Companion to superfly/flyctl#5287, which unfreezes the generated reference. That PR deliberately leaves
--deleteout of the sync so these deletions happen here, reviewed, rather than unannounced on the first run.Deleted rather than annotated, and that was the choice. Keeping them with the existing
litefs-sunsetsnippet would have cost no redirects, which is how the unmanaged Postgres guides were archived. The difference is that those guides describe an architecture people still run, so the page retains standalone value. A flag list for a command that does not execute does not clear that bar, and the explanation someone actually needs already exists onlitefs/cloud-backups, which carries the sunset warning and links the community post.On redirect count, this is an increase and I want to be straight about it. 604 to 615. The eleven redirects that pointed into these pages now point at
/litefs/cloud-backups, which costs nothing. The eleven/flyctl/cmd/fly_litefs-cloud*URLs are live and returning 200 today, so deleting the pages without redirecting them would turn working URLs into 404s. Eleven new entries is the price of not doing that. A wildcard would collapse them, and docs.json has one:slug*precedent, but the pattern needed here does not fall on a path-segment boundary so I did not risk it.Verified before pushing. No nav reference to any deleted page remains, checked by walking the navigation tree rather than grepping. No redirect points into a deleted page. The
fly litefs-cloudgroup and its nestedfly litefs-cloud clustersgroup are both gone. docs.json still parses, and I edited it surgically rather than reserializing, so the diff is the eleven destinations plus the new entries rather than 604 reformatted lines.LiteFS the project is untouched. Only the Cloud service was retired, which the snippet says explicitly, so
litefs/indexand the rest of that section are unchanged. Nothing was pointed at the LiteFS index for that reason: it describes a product that still exists.What this leaves.
flyctl/cmdnow holds 305 pages. The generator produces 305. The sets differ by two:fly.mdxis a duplicate of the root page that nothing links to, andfly_wireguard_token-modeis a new command the first sync will add. The duplicate is a separate question from retirement, so it is not in this PR, and it is the remaining reason--deletecannot go back yet.