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

use standard example.com domain for code sample #5031

Merged
merged 3 commits into from
Oct 12, 2023
Merged

use standard example.com domain for code sample #5031

merged 3 commits into from
Oct 12, 2023

Conversation

bennycode
Copy link
Contributor

@bennycode bennycode commented Oct 11, 2023

Description (required)

I found valuable information on how Astro generates anchor IDs in the German translation for Heading IDs. However, this part was missing in the English version, which is why I am submitting this PR to address it.

Related issues & labels (optional)

  • Suggested label: hacktoberfest-accepted

@netlify
Copy link

netlify bot commented Oct 11, 2023

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit c16e46a
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/652824591b45df0008007488
😎 Deploy Preview https://deploy-preview-5031--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.

Copy link
Contributor

@astrobot-houston astrobot-houston 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 opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@sarah11918
Copy link
Member

Thank you for this! I'm going to have to do a bit of digging in the history, because usually if there's a discrepancy between languages, it means the English was updated and the translation did not get updated to match. It would be a little unusual in our system for the opposite to happen. So, it's possible that this information was removed from the English because it's no longer true!

We'll do some digging and verify to be sure! 🙌

@sarah11918 sarah11918 added improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) should this be documented? Need to figure out whether this is something to add to documentation or not hacktoberfest-accepted Mark a PR as accepted to contribute towards Hacktoberfest labels Oct 11, 2023
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.

Hi @bennycode , it turns out this information was intentionally removed from here and some information reorganized intentionally. Apparently we do still use github-slugger, but with modifications that would be a little much to explain here so it makes more sense to keep that out so it's not misleading info. The information about the plugin usage was moved down to another section, so we do think the current page contains all the info we wanted to include, in the places we wanted to include it.

Even though we've established that the current version of the English site is our preferred content, I appreciate you bringing this to our attention! Since you're Hacktoberfesting, I've made an alternate addition to this page that we can give you to count for credit! We have been wanting to make sure our code snippet example domains follow standard advice and use example.com, and I spotted that right next to your original suggestion.

So, I've made that change here and we can get you not only your first docs PR, but also a Hacktoberfest PR! It's still a valuable contribution, and we spotted it thanks to you! 🙌

src/content/docs/en/guides/markdown-content.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/markdown-content.mdx Outdated Show resolved Hide resolved
@sarah11918 sarah11918 changed the title describe generation for heading IDs use standard example.com domain for code sample Oct 12, 2023
@sarah11918 sarah11918 added code snippet update Updates a code sample: typo, outdated code etc. and removed improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) should this be documented? Need to figure out whether this is something to add to documentation or not labels Oct 12, 2023
@sarah11918 sarah11918 merged commit b193c2c into withastro:main Oct 12, 2023
@bennycode bennycode deleted the patch-1 branch October 14, 2023 21:25
@bennycode
Copy link
Contributor Author

Hi @sarah11918, thank you so much for your detailed response. I am truly amazed by the thorough documentation process at Astro. It's absolutely top-notch. 👍

I just wanted to express my gratitude for giving me credits for Hacktoberfest. Your kindness is greatly appreciated. Wishing you a fantastic weekend. 💫

MoustaphaDev added a commit that referenced this pull request Nov 13, 2023
…-reference.mdx (#5367)

* i18n(fr) Update markdown-content.mdx

Update and fix old translation and #5031 #5300 #5191

* Update markdown-content.mdx

Fix link L100

* Fix Link Reading time L519

* Add reading-time.mdx

* Add reading-time.mdx

Add french translate for fix link error

* Fix link

* Fix recipe link reading time markdown-content.mdx

* Fix link recipe reading time

* Update markdown-content.mdx

* Create reading-time.mdx

Fix blnk into name folder recipes

* Delete src/content/docs/fr/recipes  directory

* Update cli-reference.mdx

Add translation of cli-reference file

* Update src/content/docs/fr/guides/markdown-content.mdx

Co-authored-by: Thomas Bnt <[email protected]>

* Update src/content/docs/fr/guides/markdown-content.mdx

Co-authored-by: Thomas Bnt <[email protected]>

* Update src/content/docs/fr/recipes/reading-time.mdx

Co-authored-by: Thomas Bnt <[email protected]>

* Update src/content/docs/fr/guides/markdown-content.mdx

Co-authored-by: Thomas Bnt <[email protected]>

* Update src/content/docs/fr/reference/cli-reference.mdx

Je pense que tu as raison

Co-authored-by: Thomas Bnt <[email protected]>

* Update src/content/docs/fr/guides/markdown-content.mdx

Oh bien vue merci

Co-authored-by: Happydev <[email protected]>

* Update src/content/docs/fr/guides/markdown-content.mdx

Merci

Co-authored-by: Happydev <[email protected]>

* Update src/content/docs/fr/reference/cli-reference.mdx

Co-authored-by: Happydev <[email protected]>

* Update src/content/docs/fr/reference/cli-reference.mdx

Co-authored-by: Happydev <[email protected]>

* Update src/content/docs/fr/recipes/reading-time.mdx

Co-authored-by: Happydev <[email protected]>

---------

Co-authored-by: Thomas Bnt <[email protected]>
Co-authored-by: Happydev <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code snippet update Updates a code sample: typo, outdated code etc. hacktoberfest-accepted Mark a PR as accepted to contribute towards Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants