Release Lit v3 pre-release docs with blog post #1116

AndrewJakubowicz · 2023-05-12T22:25:11Z

Adds the Lit v3 pre-release documentation. Fixes #1109

Copied all the v2 docs to v3.
Then fixed all cross links /docs/v2 to /docs/v3.
Replaced {% api with {% api-v3 which ensures links to API go to v3 api.
Updated the upgrade guide page with Lit 3.0 specific guidance.
Added a pre-release banner.
Made it so that switching between v2 and v3 keeps you on the same page (using manual versionLinks). Note this system does not support generated API pages.

Requirements pages were updated by @augustjk in #1118 - Thank you!

Tested manually & via existing tests.

The only file changed in the move is the root `docs.json` file. Instead a `v2.json` file was added.

This copies over and adds the correct permalinks to the selected version content. Currently moving `v2` -> `unversioned`.

Unversioned links will be generated automatically by the generated unversioned pages.

This works by piping all the content through a function that will fix cross links on unversioned pages.

The versioned URL is stripped for unversioned URLs by our tooling. Add a test to confirm this behavior.

- Replaced sync fs with async fs. - Made lightweight YAML parser more robust using regex.

Currently the Lit 3 commit being used is d04a3e30eb3ae3520fb0ac163fb5ddbbf6030620 because lit/lit#3894 fixes building Lit 3. API docs are visible at /docs/api/v3/

This will hopefully avoid the Github Actions failures.

Thank you Augustine! Re-ran generator with no content changes.

Co-authored-by: Augustine Kim <[email protected]>

- Find replace all /v2/ with /v3/ - Replace api shortcode with api-v3 shortcode - linking to v3 api docs

github-actions · 2023-05-12T22:26:43Z

A live preview of this PR will be available at the URL(s) below.
The latest URL will be appended to this comment on each push.
Each build takes ~5-10 minutes, and will 404 until finished.

AndrewJakubowicz · 2023-05-13T01:57:00Z

TODO: Hide from search index.

This makes the page a duplicate of the v2 page. Git for some reason did not include these changes when merging from main.

A user on v2 docs for a certain page should remain on that page when switching to v3 and vice-versa. This change makes it so switching between v2 and v3 will keep you on the same page, but provide the different versions of the page. Tested manually on every single page.

augustjk

A couple minor suggestions

packages/lit-dev-content/site/docs/v3/releases/upgrade.md

* Update tools section for v3 * Better wording for versions tested

…-v3-docs

Co-authored-by: Augustine Kim <[email protected]>

* Lit 3.0 pre-releases blog post * Apply suggestions from code review * Add link to upgrade guide --------- Co-authored-by: Augustine Kim <[email protected]>

AndrewJakubowicz and others added 22 commits May 9, 2023 16:56

Copy over all unversioned content into a versioned directory

6615bb6

The only file changed in the move is the root `docs.json` file. Instead a `v2.json` file was added.

Add initial build-unversioned-docs script.

19a07fb

This copies over and adds the correct permalinks to the selected version content. Currently moving `v2` -> `unversioned`.

Fix wireit so npm run dev doesnt spin infinitely.

abfec32

Add rel=canonical link from latestVersion to unversioned page.

e56c92b

Make all authored cross links versioned.

487ac0c

Unversioned links will be generated automatically by the generated unversioned pages.

Add fixUnversionedCrossLinks so unversioned cross-linking work.

1901713

This works by piping all the content through a function that will fix cross links on unversioned pages.

Add integration tests checking added features.

d8fe522

unblock failing link by adding it to the known good list.

99bc58d

Fix api shortcode such that it uses a versioned URL

132a32c

The versioned URL is stripped for unversioned URLs by our tooling. Add a test to confirm this behavior.

Apply code review feedback. Thank you!

116eb04

Code review feedback from Justin

191905a

- Replaced sync fs with async fs. - Made lightweight YAML parser more robust using regex.

Add undiscoverable v3 generated documentation.

6b7e419

Currently the Lit 3 commit being used is d04a3e30eb3ae3520fb0ac163fb5ddbbf6030620 because lit/lit#3894 fixes building Lit 3. API docs are visible at /docs/api/v3/

Explicitly bump node heap size.

6bd0076

This will hopefully avoid the Github Actions failures.

Add types/codemirror to fix TS 5 error.

7d6c201

Thank you Augustine! Re-ran generator with no content changes.

Remove unneeded dependency

dba2615

Co-authored-by: Augustine Kim <[email protected]>

Code review feedback with Wireit env.

73b5ed3

Fix formatting & filter out v3/api/index.html page

1c359db

Merge branch 'main' of github.com:lit/lit.dev into version-v3-pre

b3a7c73

Copy over v2 docs to v3 unchanged.

d1b2b73

Add banner and config

60e66a3

Fix all cross links in v3 docs to be v3 specific.

ca73955

- Find replace all /v2/ with /v3/ - Replace api shortcode with api-v3 shortcode - linking to v3 api docs

Add Lit 3.0 upgrade guide - first attempt.

d5bf37b

AndrewJakubowicz force-pushed the version-v3-docs branch from 09f025f to d5bf37b Compare May 12, 2023 22:26

Base automatically changed from version-v3-pre to main May 15, 2023 17:43

AndrewJakubowicz added 3 commits May 15, 2023 10:44

Merge branch 'main' of github.com:lit/lit.dev into version-v3-docs

22fc70d

Add v3 to the Lit.dev dropdown.

586b050

Upstream ssr client-usage docs to v3 page.

6108ce5

This makes the page a duplicate of the v2 page. Git for some reason did not include these changes when merging from main.

AndrewJakubowicz changed the title ~~Add Lit v3 docs (undiscovered)~~ Add Lit v3 pre-release docs May 15, 2023

AndrewJakubowicz added 2 commits May 15, 2023 13:05

Remove pre-release v3 docs from search index

b8bfeeb

AndrewJakubowicz marked this pull request as ready for review May 15, 2023 20:35

AndrewJakubowicz requested review from augustjk and justinfagnani May 15, 2023 20:35

augustjk approved these changes May 15, 2023

View reviewed changes

packages/lit-dev-content/site/docs/v3/releases/upgrade.md Outdated Show resolved Hide resolved

packages/lit-dev-content/site/docs/v3/releases/upgrade.md Outdated Show resolved Hide resolved

augustjk and others added 6 commits May 15, 2023 14:05

Update tools section for v3 (#1118)

62e4b98

* Update tools section for v3 * Better wording for versions tested

Add pre-releases banner content to v3 banner.

de6d620

Merge branch 'version-v3-docs' of github.com:lit/lit.dev into version…

13c9807

…-v3-docs

Update packages/lit-dev-content/site/docs/v3/releases/upgrade.md

00cfb49

Co-authored-by: Augustine Kim <[email protected]>

Update packages/lit-dev-content/site/docs/v3/releases/upgrade.md

e9a53fd

Co-authored-by: Augustine Kim <[email protected]>

Lit 3.0 pre-releases blog post (#1115)

08cdc7d

* Lit 3.0 pre-releases blog post * Apply suggestions from code review * Add link to upgrade guide --------- Co-authored-by: Augustine Kim <[email protected]>

AndrewJakubowicz changed the title ~~Add Lit v3 pre-release docs~~ Add Lit v3 pre-release docs with blog post May 15, 2023

AndrewJakubowicz changed the title ~~Add Lit v3 pre-release docs with blog post~~ Release Lit v3 pre-release docs with blog post May 15, 2023

AndrewJakubowicz and others added 3 commits May 15, 2023 15:07

Remove a small paragraph that didn't really make sense from upgrade.

5417170

Add missing word "can".

bd43fdd

Fix blog dropdown referring 3.0 -> v3

74a54e0

AndrewJakubowicz merged commit 00ebfa0 into main May 15, 2023

AndrewJakubowicz deleted the version-v3-docs branch May 15, 2023 22:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Release Lit v3 pre-release docs with blog post #1116

Release Lit v3 pre-release docs with blog post #1116

Uh oh!

AndrewJakubowicz commented May 12, 2023 •

edited

Loading

Uh oh!

github-actions bot commented May 12, 2023 •

edited

Loading

Uh oh!

AndrewJakubowicz commented May 13, 2023

Uh oh!

augustjk left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Release Lit v3 pre-release docs with blog post #1116

Release Lit v3 pre-release docs with blog post #1116

Uh oh!

Conversation

AndrewJakubowicz commented May 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AndrewJakubowicz commented May 13, 2023

Uh oh!

augustjk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AndrewJakubowicz commented May 12, 2023 •

edited

Loading

github-actions bot commented May 12, 2023 •

edited

Loading