docs: switch to Zensical, fix publishing, and restyle the reference - #833
Merged
Merged
Conversation
… that exists `start --config-path` read the log prefix variables instead of PGLS_CONFIG_PATH, and the PGLS_* names now come first so they win over the legacy PGT_* names. `init` wrote $schema as /schemas/<version>/schema.json, which doesn't exist; the docs publish it under /<version>/schema.json.
Rule summaries no longer run words together, database rule descriptions render their backticks, rule pages get a compact metadata block with the Postgres error codes of typecheck rules, and database rule pages move to reference/database-rules with their SQL collapsed. Typecheck examples run against the built-in catalog, every rule records the release it shipped in, and the generator updates the CLI reference and default configuration again, whose section markers it no longer matched.
Publishing the same commit twice made GitHub Pages keep the old site, so 0.27.0 never went live. mike's gh-pages branch is now served directly. Adds an upgrade guide for 0.27, describes the EXPLAIN-based check as legacy, and has releases open a PR that stamps the version of new rules.
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
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.
Fixes the docs site, which still served 0.26.0, and reworks the generated reference.
Why 0.27.0 never went live
The release published the same commit that the push to
mainhad published an hour earlier. GitHub Pages treats a second deployment of a commit as done, so it reported success and kept the old site:/latest/andlatest/schema.jsonare 0.26.0, and/0.27.0/is a 404. mike already commits every version togh-pages, so the docs workflow now only runs mike, and Pages should serve thegh-pagesbranch. The separate upload and deploy job is gone.Zensical
The site moves from the readthedocs theme to Zensical, with Zensical's fork of mike for the version selector. Tables wrap (readthedocs forbids line breaks in cells, which made the rule tables very wide), and the site gets search, dark mode, and copy buttons.
mkdocs.ymland the navigation stay; the only new page is an "Upgrading to 0.27" guide.Generated reference
vnextfor every rule; each rule now records its first release, backfilled from the tags.reference/database-rules/, with redirects from the old URLs, and their SQL query is collapsed at the bottom.PGLS_*variables, andenv_variables.mdmoves thePGT_*ones under "Deprecated".Type checking page
The
typecheckrules are the method; theEXPLAIN-based check is described as legacy and planned for removal (added to #832).Fixes found along the way
start --config-pathreadPGLS_LOG_PREFIX_NAMEinstead ofPGLS_CONFIG_PATH.PGLS_*variables now win over the legacyPGT_*ones.initwrote$schema: https://pg-language-server.com/schemas/<version>/schema.json, which is a 404. It now writes/<version>/schema.json.Releases
After the draft release is created, the release workflow opens a PR that replaces
version: "next"of new rules with the released version. The docs build of a release stamps the generated pages itself, so released docs are right even before that PR merges.After merging
Switch Pages to "Deploy from a branch:
gh-pages". The merge's docs run then publishes the current site, 0.27.0 included.