docs: publish the documentation - #7012
Merged
Merged
Conversation
Code Review
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
Documentation preview: https://5c74d253.shellhub-docs.pages.dev |
The website and docs origins were fixed at their .localhost dev names, so a published build sent every footer link to the reader's machine. They follow the same rule the docs already use for the website link, and the two entries that 404 on the site today are replaced by the documentation they were describing.
… published The build had no site address, so no canonical URL and no sitemap. It has both now, written against docs.shellhub.io, which is where the site ends up even while it is served somewhere else first. The documentation it replaces has 68 indexed URLs and the console links six of them, so each one redirects to the page now covering the same ground. robots.txt refuses indexing while the site lives at a temporary address, and images and fingerprinted assets are cached for a year.
Nine GIFs were 24.7 MB of a 33 MB site, one of them 4.4 MB for eight seconds of a cursor. The same recordings as MP4 and WebM are 3.5 MB in total and sharper. A <Clip> renders them muted, looping and without controls, so they behave like the images they replace and carry the same frame a screenshot does.
gustavosbarreto
force-pushed
the
docs/deploy-cloudflare
branch
from
September 1, 2026 23:45
929ae4c to
6a8b63d
Compare
The documentation had no way to reach a reader: it is not in the ui image, not in compose, and its gateway route is inside the development block. A push to master publishes it; a pull request publishes a preview and comments the URL, which is how a documentation change gets read before it is merged. The build runs the same steps validate-ui.yml already uses, and under CI, where a declared screenshot with no image fails the deploy rather than rewriting the checkout.
…r them The page opened by telling the reader to bring up a server, because the route that renders the specification is development-only, and then claimed every release publishes the bundles without saying where. They have been published all along: three files, one per edition, republished on release. They are the page now, and the local route is what it actually is - a convenience for somebody already running an instance.
|
Documentation preview: https://9e94ad28.shellhub-docs.pages.dev |
gustavosbarreto
force-pushed
the
docs/deploy-cloudflare
branch
from
September 1, 2026 23:46
6a8b63d to
0fc1a2c
Compare
Member
Author
|
/review |
Code Review CompleteThe automated review ran but did not post an updated summary — this usually means no new issues were found since the previous review. If you've pushed changes and want a fresh pass, comment |
|
Documentation preview: https://90a0d746.shellhub-docs.pages.dev |
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
2 participants
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.
The rewritten documentation has been on master for a while with no way to reach a reader: it is not in the ui image, not in compose, and its gateway route lives inside the development block. Meanwhile docs.shellhub.io still serves the Docusaurus site whose last commit is from December, and the console links six of its URLs.
This gives the site somewhere to go. A push to master publishes it to Cloudflare Pages; a pull request publishes a preview and comments the URL, which is how a documentation change gets read before it is merged. The build runs the same steps the validation workflow already uses, under CI, where a screenshot with no image fails the deploy instead of quietly rewriting the checkout.
The first deployment goes to
docsv2.shellhub.io, so the whole site can be read at a real address while the current one stays exactly where it is.robots.txtrefuses indexing until that changes, and canonical URLs are written againstdocs.shellhub.io, which is where the site ends up.The documentation being replaced has 68 indexed URLs. Every one of them redirects to the page that now covers the same ground — the six the console links included — rather than to a 404 or to the home page.
Three things were in the way of publishing at all. The shared footer had both origins fixed at their
.localhostdevelopment names, so a published page linked the reader to their own machine, and two of its links 404 on the site today. The nine animated GIFs were 24.7 MB of a 33 MB site; as video they are 3.5 MB and sharper. And the OpenAPI page told the reader to bring up a server, because the route that renders the specification is development-only, while claiming every release publishes the bundles without saying where — they have been published all along, so the page links them.