Skip to content

[i18nIgnore] Migrate to Content Collections#2546

Merged
delucis merged 101 commits intomainfrom
cc
Feb 15, 2023
Merged

[i18nIgnore] Migrate to Content Collections#2546
delucis merged 101 commits intomainfrom
cc

Conversation

@bholmesdev
Copy link
Copy Markdown
Contributor

@bholmesdev bholmesdev commented Feb 2, 2023 •
edited
Loading

What kind of changes does this PR include?

  • Changes to the docs site code

Description

  • Migrate all docs pages to a docs collection under /src/content/docs/. This preserves the existing i18n folder structure, unchanged.
  • Enforce schemas for different docs layouts based on a new type frontmatter param. This type replaces the layout param, and can be omitted when using the MainLayout. These types can be found browsing the schemas under src/content/config.ts. I'm curious if the docs team has ideas for CONTRIBUTING updates or further refactors here!
---
- layout: ~/layouts/DeployGuideLayout.astro
+ type: deploy
---
  • Update navigation mappers, open graph utilities, and other uses of glob to use getCollection.
  • Update the [lang]/[...slug].astro to render content collection entries. This also allowed for fallbacks and page routes to be generated in the same place. This also maps the type frontmatter param to the correct layout.
  • Add type safety to layout and head props.
  • Add a new splitSlugFromLang util. This helps with parsing the language out of the generated content collection slug.
  • Rename redirect slug routes to [...enRedirectSlug] and [enBaseLevelRedirectSlug]. This was purely for readability debugging our new slug generation routes. I'll differ to @delucis for changing this naming back.

Chores

  • Bump Astro core to 2.0, and peer packages to their respective majors
  • Update markdown config to use new gfm and smartypants flags

@bholmesdev
deps: beta Astro
f5dcd65
@bholmesdev
wip: remove allowJs from tsconfig (something borking with content?)
bb99ae0
@bholmesdev
chore: astro content env
cb86416
@bholmesdev
wip: schemas, get something displaying in dev
4280b2e
@bholmesdev
chore: remove h1 debug
90c8849
@bholmesdev
fix: src/pages -> src/content/docs
d43e4ee
@bholmesdev
chore: old migrate files
162b3d7
@bholmesdev
deps: astro, mdx, chris pkgs
23170c0
@bholmesdev
chore: rebase
bb1d837
@bholmesdev
refactor: new splitSlugFromLang util
d48742b
@bholmesdev
chore: check unit exists
1af98f2
@bholmesdev
fix: bad rel paths
d22af14
@bholmesdev
refactor: switch to collection filter
0cbf10d
@bholmesdev
feat: add back og path with getCollection
f4fb129
@bholmesdev
fix: redirect slugs
d45c917
@bholmesdev
fix: baseLevel typos
d79b368
@bholmesdev
chore: add deploy schema
5e3ef26
@bholmesdev
refactor: layout prop -> switch case on type
3058402
@bholmesdev
chore: remove gfm, turn off auto-smartypants
29efc85
@bholmesdev
chore: remove as Props
22a0e4a
@bholmesdev
fix: update integration docs gen
473460c
@bholmesdev
fix: move open-graph out of en
ba72b52
@bholmesdev
deps: bump to latest astro
e0baa14
@bholmesdev
deps: astro and mdx latest
6a21832
@bholmesdev
fix: remove ~layout from error docgen
15b6bf3
@bholmesdev
chore: remove MainLayout from all code gen
1ed2c17
@bholmesdev
chore: remove layout prop from new pages
20e029d
@netlify
Copy link
Copy Markdown

netlify bot commented Feb 2, 2023 •
edited
Loading

✅ Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 3f59d05
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/63ed18f81ac0510009b5293c
😎 Deploy Preview https://deploy-preview-2546--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Feb 2, 2023
@sarah11918
Copy link
Copy Markdown
Member

sarah11918 commented Feb 15, 2023

Confirming that I have tested/looked for (large screen size):
Tutorial: check boxes, multiple choice quizzes, confetti
Components: package manager tabs (including selecting one affecting all on the page), Since (new added in), Right sidebar tracking
Alt Layouts: tutorial, deploy, migrate, CMS
Different languages: navigated in pl and pt-Br

@yanthomasdev
Copy link
Copy Markdown
Member

yanthomasdev commented Feb 15, 2023

I had checked this PR before the optimizations and everything was working properly, and again I'm here to confirm everything looks great!

What I tested:

  • Are components working? (Since, Badge, Version, Tabs, Algolia, Dev-only warning, etc) ✔️
  • Are all pages and their subpages being rendered? (Integrations, Error Reference, 404...) ✔️
  • Are our translations there, working as intended? (Language Selector, Fallback, "EN", etc) ✔️
  • No layout bugs or malfunctioning mobile features? ✔️

@sarah11918
Copy link
Copy Markdown
Member

sarah11918 commented Feb 15, 2023

is updating our contributor/translator guide a pre-req to merging this? Should we have that available first, @delucis @yan-thomas ?

@yanthomasdev
Copy link
Copy Markdown
Member

yanthomasdev commented Feb 15, 2023

is updating our contributor/translator guide a pre-req to merging this? Should we have that available first, @delucis @yan-thomas ?

I believe @delucis made all the necessary changes to these, couldn't find anywhere else in our .md guides where we mention src/pages rather than src/content, so we should be good to go!

@sarah11918
Copy link
Copy Markdown
Member

sarah11918 commented Feb 15, 2023

DOES THIS MEAN I APPROVE????

sarah11918
sarah11918 approved these changes Feb 15, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not found any reason not to approve this...

Great work @delucis & @bholmesdev !

Let's ... NOT do this again soon?? 😅

@delucis delucis merged commit 19fa02f into main Feb 15, 2023
@delucis delucis deleted the cc branch February 15, 2023 21:22
@piro-hiroki piro-hiroki mentioned this pull request Oct 8, 2023
Merged
@McFlyPartages McFlyPartages mentioned this pull request Jan 2, 2024
Merged
@McFlyPartages McFlyPartages mentioned this pull request Jan 13, 2024
Merged
@trueberryless trueberryless mentioned this pull request Oct 22, 2024
Merged
@trueberryless trueberryless mentioned this pull request Nov 18, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sarah11918 sarah11918 sarah11918 approved these changes

@yanthomasdev yanthomasdev yanthomasdev approved these changes

Assignees

@delucis delucis

Labels

🚨 action i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help!

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bholmesdev @sarah11918 @yanthomasdev @delucis