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

feat(i18n): document new option #6265

Merged
merged 5 commits into from
Jan 18, 2024
Merged

feat(i18n): document new option #6265

merged 5 commits into from
Jan 18, 2024

Conversation

ematipico
Copy link
Member

Description (required)

Closes PLT-1431

This PR adds documentation for the upcoming new option. I added a small chapter, I don't know if I need to repeat the examples. Let me know what you think.

Related issues & labels (optional)

  • Closes #
  • Suggested label:

For Astro version: 4.2. See astro PR #9638.

Copy link

vercel bot commented Jan 11, 2024

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

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Jan 18, 2024 11:02am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
docs-i18n ⬜️ Ignored (Inspect) Visit Preview Jan 18, 2024 11:02am

@ematipico ematipico added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! labels Jan 11, 2024
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.

Hello! Thank you for making sure this is documented!

I have added some potential alternative phrasing, should you desire to choose one.
I hope this helps!

src/content/docs/en/guides/internationalization.mdx Outdated Show resolved Hide resolved
@sarah11918
Copy link
Member

sarah11918 commented Jan 12, 2024

Tried adding a tiny bit to the section directly above to help with the issue where people are forgetting to make an index page when prefixDefaultLocale is set to true:

  • highlights, and adds an inline comment for index.astro
  • moves the second bullet point down and expands on what this option means (including the file NAME, not just the root URL)

image

Copy link
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.

@ematipico - See what you think about these changes. Since I knew you were also adding an error message about a missing index.astro file, I figured we could help the existing documentation here too, at the same time.

Please check the additions below and edit for correctness as necessary. e.g. I invented a reason why someone might configure this as false, to give more context. I think it's ok to expand this, but I'd like to make sure this is accurate/gives the right nuance!

@sarah11918 sarah11918 added the merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) label Jan 12, 2024
@ematipico
Copy link
Member Author

Thank you, Sarah; I like very much the new phrasing!

@sarah11918 sarah11918 added this to the 4.2.0 milestone Jan 12, 2024
@sarah11918
Copy link
Member

Note to self: ADD A LINK TO THE CONFIG REFERENCE ITEM

But otherwise, happy with the wording!

Copy link
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.

Link will fail until #6437 is merged.

@sarah11918 sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Jan 17, 2024
@sarah11918 sarah11918 merged commit 3b24508 into main Jan 18, 2024
8 checks passed
@sarah11918 sarah11918 deleted the feat/document-new-option branch January 18, 2024 11:03
ematipico added a commit that referenced this pull request Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants