Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[i18nIgnore] Integration READMEs in docs! #5839

Merged
merged 11 commits into from
Dec 21, 2023

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented Dec 19, 2023

Description (required)

This performs all the content changes required for the Integration READMEs :

  • Each /en/ page has updated frontmatter:
    - No more dev warning
    - githubURL changed to githubIntegrationURL to separate logic for EditLink.astro and PageTitle.astro (Error messages and config-ref still need to use githubURL for off-site editing, but the integrations need a header link back to the package on GitHub, too.
    - hasREADME: true deleted
  • the dev warning and video component imports have been removed (Only Tailwind needs the video import)
  • added a code comment to /scripts/generate-integration-pages.ts so that this file is included. Will need Chris to review what changes (deletion?) needs to be made here.
  • EditLink.astro ended up with an extra blank line, but at least it's here for easy reference in case Chris decides he prefers to tackle this from that end, vs my strategy to update PageTitle.astro logic.

Tested behaviour:

  • Dev server doesn't crash 😅
  • Builds fine!
  • Individual integration pages work
  • The integration headers still work: the github link goes to the package
  • The edit this page on the integration pages works, now pointing to the current page in docs

Accompanying tasks outside of docs code:

@sarah11918 sarah11918 added the site improvement Some thing that improves the website functionality - ask @delucis for help! label Dec 19, 2023
Copy link

vercel bot commented Dec 19, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Dec 21, 2023 6:05pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
docs-i18n ⬜️ Ignored (Inspect) Visit Preview Dec 21, 2023 6:05pm

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Dec 19, 2023
Copy link
Contributor

@VoxelMC VoxelMC left a comment

Choose a reason for hiding this comment

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

Very cool! Was confused about this whole process for quite some time :P

Copy link
Member

@dreyfus92 dreyfus92 left a comment

Choose a reason for hiding this comment

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

Awesome job @sarah11918, just a few a suggestions 😁

Co-authored-by: Paul Valladares <[email protected]>
@sarah11918
Copy link
Member Author

Amazing work catching these, @dreyfus92 ! 🚀

@ElianCodes ElianCodes self-requested a review December 21, 2023 14:22
@sarah11918 sarah11918 added the help - leave feedback Let's crowd source this one! Looking for comments, suggestions, LGTMs! label Dec 21, 2023
Copy link
Member

@ElianCodes ElianCodes left a comment

Choose a reason for hiding this comment

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

I'm not sure that we can delete the script yet, but everything else is looking good!

Copy link
Member

@TheOtterlord TheOtterlord left a comment

Choose a reason for hiding this comment

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

This is great!

src/components/starlight/EditLink.astro Outdated Show resolved Hide resolved
@sarah11918 sarah11918 merged commit 3cf03d5 into main Dec 21, 2023
8 checks passed
@sarah11918 sarah11918 deleted the integration-readmes-moved-to-docs branch December 21, 2023 18:24
ematipico pushed a commit that referenced this pull request Jan 26, 2024
Co-authored-by: Voxel <[email protected]>
Co-authored-by: Paul Valladares <[email protected]>
Co-authored-by: Reuben Tier <[email protected]>
Co-authored-by: = <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚨 action help - leave feedback Let's crowd source this one! Looking for comments, suggestions, LGTMs! i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! site improvement Some thing that improves the website functionality - ask @delucis for help!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants