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

revive recipes #9900

Merged
merged 11 commits into from
Nov 5, 2024
Merged

revive recipes #9900

merged 11 commits into from
Nov 5, 2024

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented Oct 31, 2024

Description (required)

This page addresses the issue where we have a hidden/unused en/recipes/ page because this page DOES exist in other languages.

TRANSLATORS: This PR revergs the English recipes.mdx to match the (never updated) translations, so it's possible that existing translations may not need to update recipes.mdx at all. Use your judgement, and if your existing page is "close enough", you can assume the content is fine! You can make a trivial commit to update the status of your page to "updated" if needed.

This PR also removes the talks.mdx page as it was more of a maintenance burden than helpful.

Quick fix for haunted recipe page

  • put recipes page in sidebar somewhere
  • remove the redirect to direct away from this page
  • Remove the other community page (talks) in all languages if we do end up removing from the sidebar!! (No new "ghost page" 😅 )
  • Remove commented out ghost entry from sidebar once we're sure
  • LUNARIA TRACKING STATEMENT - not needed; all translators should check their pages for updates to be safe!

Copy link

netlify bot commented Oct 31, 2024

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit d0a05f8
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/672a3c8ff81fec0008500e47
😎 Deploy Preview https://deploy-preview-9900--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 configuration.

@astrobot-houston
Copy link
Contributor

astrobot-houston commented Oct 31, 2024

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en community-resources/content.mdx Source changed, localizations will be marked as outdated.
en community-resources/talks.mdx Source removed, will stop being tracked.
en recipes.mdx Source changed, localizations will be marked as outdated.
es community-resources/talks.mdx Localization removed, will be marked as missing.
fr community-resources/talks.mdx Localization removed, will be marked as missing.
it community-resources/talks.mdx Localization removed, will be marked as missing.
ko community-resources/talks.mdx Localization removed, will be marked as missing.
pt-br community-resources/talks.mdx Localization removed, will be marked as missing.
ru community-resources/talks.mdx Localization removed, will be marked as missing.
zh-cn community-resources/talks.mdx Localization removed, will be marked as missing.
en nav.ts Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@sarah11918
Copy link
Member Author

All looks good to me, but need a place in the sidebar or to otherwise link to this! Now the haunted mystery page has content, but can't be accessed!

@ArmandPhilippot
Copy link
Member

Ah indeed, in the next version (your sidebar experiment) it would be simpler to put it in the sidebar I think but there...

Maybe:

  1. Rename the Community Resources section to Resources
  2. Rename the Courses, Guides, and Recipes to Community Resources
  3. Add Recipes under the renamed Resources

But... This idea assumes that Talks, Interviews, and Streams always involves Astro members (which is therefore more or less "official")... which may not be the case (I haven't checked). If not, perhaps split the content out of Talks, Interviews, and Streams so that this page only lists contents where Astro members (at the time of recording at least) are involved and move the rest to the renamed Community resources.

Otherwise, maybe we can add Recipes to Learn the basics in the meantime... but it doesn't seem to be necessarily basic so it might not be better... Or perhaps add Recipes to Maintain Your Project?

For the moment I don't see any other alternatives. It doesn't seem to me that a link to Recipes would make more sense on one page than another...

@sarah11918
Copy link
Member Author

Thanks for the review @ArmandPhilippot ! As we discussed on the call, we may be doing away with all of this content except official recipes in the new design! (Sooner?) I think we are leaning towards we don't need to be people's search engines, although it's fair that if we can help some people, the content may not be harmful. (That said, we don't regularly review and update, so it may give more weight than we intend.)

To fix the immediate problem, which is that a page at /lang/recipes exists in a handful of other languages that would be difficult to quickly fix, adding back this content at en/recipes.mdx is by far the path of least resistance! That is the strategy here to avoid a massive i18n avalanche of debris.

But we then have the problem of "OK, but people need to be able to find the recipe content" so we need SOME place in the sidebar for it now! 😅

@sarah11918
Copy link
Member Author

sarah11918 commented Nov 1, 2024

One possibility? Does this kind of match your thinking?

image

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Nov 1, 2024
@sarah11918 sarah11918 added the information architecture reorganizes content on the site label Nov 1, 2024
Co-authored-by: Armand Philippot <[email protected]>
src/i18n/en/nav.ts Outdated Show resolved Hide resolved
@ArmandPhilippot
Copy link
Member

One last point that requires confirmation since I'm not familiar enough with how Starlight works:

If I visit a recipe in the Netlify preview, both "How-to Recipes" and "Community Resources" links are highlighted. Is this due to the redirect being still "active" in the preview or is there something else to fix?
For example if I visit Create a dev toolbar app, in the sidebar I see:

astro-docs-recipes

I expect to see only "How-to Recipes" highlighted.

Other than that, LGTM! But I guess you're waiting for other opinions. 😅

@sarah11918 sarah11918 marked this pull request as draft November 5, 2024 14:28
@sarah11918
Copy link
Member Author

sarah11918 commented Nov 5, 2024

Converting to draft while I consider maybe handling this for v5 docs instead tackle the highlighting issue!

@sarah11918
Copy link
Member Author

Highlighting should be fixed with this next commit! Thank you so much for spotting Armand!

image
image

@sarah11918 sarah11918 marked this pull request as ready for review November 5, 2024 15:29
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

LGTM! Glad we are fixing the weird placeholder page even if all of this goes away with the v5 docs 🙌

@sarah11918 sarah11918 merged commit e547a32 into main Nov 5, 2024
10 checks passed
@sarah11918 sarah11918 deleted the unhaunted-recipes branch November 5, 2024 15:56
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Nov 6, 2024
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Nov 6, 2024
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Nov 6, 2024
yanthomasdev added a commit that referenced this pull request Nov 6, 2024
Signed-off-by: Thomas Bonnet <[email protected]>
Co-authored-by: Yan <[email protected]>
Co-authored-by: ArmandPhilippot <[email protected]>
yanthomasdev added a commit that referenced this pull request Nov 6, 2024
See #9900

Co-authored-by: Yan <[email protected]>
Co-authored-by: thomasbnt <[email protected]>
yanthomasdev added a commit that referenced this pull request Nov 6, 2024
See #9900 and #9888

Co-authored-by: Yan <[email protected]>
Co-authored-by: thomasbnt <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! information architecture reorganizes content on the site
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants