docs: Update SSG documentation to run build instead of preview #5269
Conversation
This file contains 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
Fix the docs about SSG using npm run build instead of preview
👷 Deploy request for qwik-insights pending review.Visit the deploys page to approve it
|
ibousfiha
changed the title
|
Would it not be better to have preview generate the SSG pages instead? |
1 similar comment
|
Would it not be better to have preview generate the SSG pages instead? |
I'm on the same page with you; having the Additionally, when I attempted to remove the Could not resolve entry module "src/entry.preview.tsx/index.html".
error during build:
RollupError: Could not resolve entry module "src/entry.preview.tsx/index.html".
at error (file:///Users/issambousfiha/Projects/qwik-app/node_modules/rollup/dist/es/shared/node-entry.js:2287:30)
at ModuleLoader.loadEntryModule (file:///Users/issambousfiha/Projects/qwik-app/node_modules/rollup/dist/es/shared/node-entry.js:24881:20)
at async Promise.all (index 0)I can open a separate issue to address this problem. Would that be a good next step? |
wmertens
approved these changes
Oct 4, 2023
|
Thanks! Yes, an issue for fixing preview would be good. |
kodiakhq bot
pushed a commit
to ascorbic/unpic-img
that referenced
this pull request
Oct 8, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@builder.io/qwik](https://qwik.builder.io/) ([source](https://togithub.com/BuilderIO/qwik)) | [`1.2.12` -> `1.2.13`](https://renovatebot.com/diffs/npm/@builder.io%2fqwik/1.2.12/1.2.13) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>BuilderIO/qwik (@​builder.io/qwik)</summary> ### [`v1.2.13`](https://togithub.com/BuilderIO/qwik/releases/tag/v1.2.13) [Compare Source](https://togithub.com/BuilderIO/qwik/compare/v1.2.12...v1.2.13) #### What's Changed - fix(insights): wrapper style by [@​gioboa](https://togithub.com/gioboa) in [QwikDev/qwik#5193 - docs: fix typos by [@​igorbabko](https://togithub.com/igorbabko) in [QwikDev/qwik#5195 - fix(qwik-auth): allow multiple set-cookie headers by [@​ulic75](https://togithub.com/ulic75) in [QwikDev/qwik#5194 - feat(insights): return prefetch list per route by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5197 - feat(insights): return prefetch list per route by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5198 - chore(qwik-auth): v0.1.3 by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5201 - feat(cli): add barrel template to `new` command by [@​dapids](https://togithub.com/dapids) in [QwikDev/qwik#5202 - docs: add `dimension.dev` to showcase by [@​necatikcl](https://togithub.com/necatikcl) in [QwikDev/qwik#5200 - fix(core): Added StringSerializer for strings that start with the prefixes of serializers. by [@​genki](https://togithub.com/genki) in [QwikDev/qwik#5176 - fix(serializers): fix for serialization of an empty set or map by [@​Varixo](https://togithub.com/Varixo) in [QwikDev/qwik#5209 - docs: add qwik-spin-delay library by [@​harshmangalam](https://togithub.com/harshmangalam) in [QwikDev/qwik#5214 - docs(ecosystem): add qwik-image library by [@​gioboa](https://togithub.com/gioboa) in [QwikDev/qwik#5216 - chore: add prettier-plugin-tailwindcss to tailwind starter ([#​5217](https://togithub.com/BuilderIO/qwik/issues/5217)) by [@​nsdonato](https://togithub.com/nsdonato) in [QwikDev/qwik#5217 - docs: Correct image size and CLS in resumable example by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5220 - docs: fix url for useVisibleTask by [@​nsdonato](https://togithub.com/nsdonato) in [QwikDev/qwik#5223 - feat: bootstrap integration adapter by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5222 - chore: update file path in next-steps.tsx by [@​Craiqser](https://togithub.com/Craiqser) in [QwikDev/qwik#5212 - refactor: remove extraneous isElement call by [@​wmertens](https://togithub.com/wmertens) in [QwikDev/qwik#5210 - docs: fix edit this page for deprecated features by [@​nsdonato](https://togithub.com/nsdonato) in [QwikDev/qwik#5224 - chore: update firebase starter to contemplate dist folder by [@​nsdonato](https://togithub.com/nsdonato) in [QwikDev/qwik#5225 - feat(cachecontrol): add second `target` argument to cacheControl by [@​maiieul](https://togithub.com/maiieul) in [QwikDev/qwik#5226 - fix: should SSR render if accept header includes */* by [@​SamVerschueren](https://togithub.com/SamVerschueren) in [QwikDev/qwik#5234 - docs: fix 404 links by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5236 - docs: Add frostytools.com to pages.json by [@​n8sabes](https://togithub.com/n8sabes) in [QwikDev/qwik#5239 - docs: fix typo by [@​the-r3aper7](https://togithub.com/the-r3aper7) in [QwikDev/qwik#5241 - chore(contributing.md): remove unnecessary step to test against docs … by [@​maiieul](https://togithub.com/maiieul) in [QwikDev/qwik#5244 - chore(contributing.md): added info when package linking doesn't work by [@​maiieul](https://togithub.com/maiieul) in [QwikDev/qwik#5245 - docs: Build Showcase by [@​n8sabes](https://togithub.com/n8sabes) in [QwikDev/qwik#5242 - docs: documentation link and text for directory-based routing by [@​ryo-manba](https://togithub.com/ryo-manba) in [QwikDev/qwik#5246 - feat(labs): Add json debugging tool by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5259 - feat(core): Allow useContext in same elem as provider by [@​wmertens](https://togithub.com/wmertens) in [QwikDev/qwik#5258 - docs(routing): add Link prefetch documentation (alternative) by [@​maiieul](https://togithub.com/maiieul) in [QwikDev/qwik#5248 - docs(labs): document devtools/json by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5260 - fix(starter): localize configuration by [@​gioboa](https://togithub.com/gioboa) in [QwikDev/qwik#5262 - docs: fix typos by [@​igorbabko](https://togithub.com/igorbabko) in [QwikDev/qwik#5265 - docs(integrations): add valibot to modular forms guide by [@​fabian-hiller](https://togithub.com/fabian-hiller) in [QwikDev/qwik#5252 - docs: Update SSG documentation to run build instead of preview by [@​ibousfiha](https://togithub.com/ibousfiha) in [QwikDev/qwik#5269 - fix(starter): localize container attribute by [@​tzdesign](https://togithub.com/tzdesign) in [QwikDev/qwik#5268 - fix: A bug fix [#​5104](https://togithub.com/BuilderIO/qwik/issues/5104) by [@​Charlygraphy23](https://togithub.com/Charlygraphy23) in [QwikDev/qwik#5267 - docs(state): Add 'key' prop to list items by [@​nicvazquez](https://togithub.com/nicvazquez) in [QwikDev/qwik#5250 - docs: add note about `onRequest` middleware exported from `serverAuth$` by [@​jakovljevic-mladen](https://togithub.com/jakovljevic-mladen) in [QwikDev/qwik#5264 - docs(labs): update path for devtools to include https by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5271 - docs: updated phrasing for clarity by [@​bodhicodes](https://togithub.com/bodhicodes) in [QwikDev/qwik#5273 - fix: Bun adapter polyfill and redirect fix by [@​EamonHeffernan](https://togithub.com/EamonHeffernan) in [QwikDev/qwik#5272 - fix: Pr local dev docker by [@​SauravChanda](https://togithub.com/SauravChanda) in [QwikDev/qwik#5237 - refactor(core): remove useContextBoundary by [@​wmertens](https://togithub.com/wmertens) in [QwikDev/qwik#5274 - fix: shell script update in README file by [@​harshmangalam](https://togithub.com/harshmangalam) in [QwikDev/qwik#5275 - docs: improve advanced routing documentation by [@​jakovljevic-mladen](https://togithub.com/jakovljevic-mladen) in [QwikDev/qwik#5276 - chore: 1.2.13 by [@​mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5277 #### New Contributors - [@​igorbabko](https://togithub.com/igorbabko) made their first contribution in [QwikDev/qwik#5195 - [@​dapids](https://togithub.com/dapids) made their first contribution in [QwikDev/qwik#5202 - [@​maiieul](https://togithub.com/maiieul) made their first contribution in [QwikDev/qwik#5226 - [@​SamVerschueren](https://togithub.com/SamVerschueren) made their first contribution in [QwikDev/qwik#5234 - [@​ryo-manba](https://togithub.com/ryo-manba) made their first contribution in [QwikDev/qwik#5246 - [@​ibousfiha](https://togithub.com/ibousfiha) made their first contribution in [QwikDev/qwik#5269 - [@​Charlygraphy23](https://togithub.com/Charlygraphy23) made their first contribution in [QwikDev/qwik#5267 - [@​nicvazquez](https://togithub.com/nicvazquez) made their first contribution in [QwikDev/qwik#5250 - [@​bodhicodes](https://togithub.com/bodhicodes) made their first contribution in [QwikDev/qwik#5273 - [@​SauravChanda](https://togithub.com/SauravChanda) made their first contribution in [QwikDev/qwik#5237 **Full Changelog**: QwikDev/qwik@v1.2.12...v1.2.13 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9pm on sunday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ascorbic/unpic-img). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjMiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjMiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->
](https://renovatebot.com){kind=link}
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.
Overview
This PR aims to correct the documentation for SSG, specifically to suggest running build instead of preview.
What is it?
Description
This PR updates the SSG documentation to replace the recommendation of using the preview command with the build command for generating static pages. This change is important to highlight because the preview command currently does not generate any HTML static files, whereas the build command does. This ensures developers are fully aware of what each command will yield.
Use cases and why
Checklist: