Skip to content

i18n: Replace dead link in README.md. - #29699

Merged
talldan merged 1 commit into
WordPress:trunkfrom
lephleg:fix/remove-dead-readme-link
Mar 15, 2021
Merged

talldan merged 1 commit into
WordPress:trunkfrom
lephleg:fix/remove-dead-readme-link

Conversation

@lephleg

@lephleg lephleg commented Mar 10, 2021 •

Copy link
Copy Markdown
Contributor

Fixes #29696.

Alters an irrelevant link in the i18n README.md file to a more proper entry.

@lephleg
lephleg requested a review from swissspidy as a code owner March 10, 2021 03:38
@github-actions github-actions Bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Mar 10, 2021
@github-actions

Copy link
Copy Markdown

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @lephleg! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@talldan

talldan commented Mar 10, 2021 •

Copy link
Copy Markdown
Contributor

Thanks for your contribution @lephleg.

One of the checks is failing. I believe you'll need to run the npm run docs:build command from the command line to update the compiled version of the docs.

Commit and push that change and the check should pass.

Comment thread packages/i18n/README.md Resolved
@lephleg
lephleg force-pushed the fix/remove-dead-readme-link branch from e7c2bee to 9ea2c71 Compare March 10, 2021 17:01
@lephleg

lephleg commented Mar 10, 2021 •

Copy link
Copy Markdown
Contributor Author

@talldan thanks for the assistance! I tried the npm run docs:build command but all it does is reverting my changes back to the original. That's the reason the static analysis is failing after running the above command. It's not clear to me yet why this is happening though.

Following @mkaz's extended guide along with the documentation Contributor's Guide I find no reference to additional steps required in order to update an existing document. I'll have to dig in to the build script itself.

@swissspidy

Copy link
Copy Markdown
Member

@talldan thanks for the assistance! I tried the npm run docs:build command but all it does is reverting my changes back to the original. That's the reason the static analysis is failing after running the above command. It's not clear to me yet why this is happening though.

Following @mkaz's extended guide along with the documentation Contributor's Guide I find no reference to additional steps required in order to update an existing document. I'll have to dig in to the build script itself.

It's because you are modifying the built MD file.

You'll have to update the link in packages/i18n/src/sprintf.js#L23.

@lephleg
lephleg force-pushed the fix/remove-dead-readme-link branch from 9ea2c71 to d4981c0 Compare March 10, 2021 19:22
@lephleg

lephleg commented Mar 10, 2021

Copy link
Copy Markdown
Contributor Author

@talldan thanks for the assistance! I tried the npm run docs:build command but all it does is reverting my changes back to the original. That's the reason the static analysis is failing after running the above command. It's not clear to me yet why this is happening though.
Following @mkaz's extended guide along with the documentation Contributor's Guide I find no reference to additional steps required in order to update an existing document. I'll have to dig in to the build script itself.

It's because you are modifying the built MD file.

You'll have to update the link in packages/i18n/src/sprintf.js#L23.

Oh damn, I didn't realise that was generated. Thanks for the guidance @swissspidy! Clean-pushed now.

@lephleg
lephleg requested a review from swissspidy March 10, 2021 22:50
@lephleg lephleg changed the title i18n: Remove dead link in README.md. i18n: Replace dead link in README.md. Mar 13, 2021

@talldan talldan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for working on this @lephleg

@talldan
talldan merged commit bc75b62 into WordPress:trunk Mar 15, 2021
@talldan talldan added the [Type] Developer Documentation Documentation for developers label Mar 15, 2021
@github-actions

Copy link
Copy Markdown

Congratulations on your first merged pull request, @lephleg! We'd like to credit you for your contribution in the post announcing the next WordPress release, but we can't find a WordPress.org profile associated with your GitHub account. When you have a moment, visit the following URL and click "link your GitHub account" under "GitHub Username" to link your accounts:

https://profiles.wordpress.org/me/profile/edit/

And if you don't have a WordPress.org account, you can create one on this page:

https://login.wordpress.org/register

Kudos!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

i18n: Dead Readme Link?

3 participants