Create a script to update internal links of translated files

[samajammin]

Prize Bounty

75 DAI

Challenge Description

Currently when adding a new language translation or updating an existing translation (e.g. #816), all internal links within the translated markdown files must be manually updated to point to the appropriate page (i.e. the translated page vs. the corresponding English page). For instance, a link to the /learn page within the /docs/sv/what-is-ethereum/index.md file must be updated from /learn to /sv/learn (so it points to the translated page, ethereum.org/sv/learn, not the English version at ethereum.org/learn). See this commit as an example.

Create a node script to automate these updates.

Submission Requirements

The node script should take a language directory as an argument, e.g.:

yarn update-internal-links docs/translations/de/

This script should traverse all markdown files within the directory for internal links, e.g.

[some internal link](/learn/)

It should IGNORE all external links, e.g.

[some external link](https://someexternalsite.com/)

For each internal link:

• If the link does not contain the language directory passed in, add it (/learn/ —> /de/learn/)
• If the link does not have a trailing slash, add it (/de/learn → /de/learn/)
• If the link already contains the language directory, do nothing (/de/learn/ --> /de/learn/)

The script should check that the passed argument (the language directory) is in fact a valid language directory (e.g. by checking the directory names within /docs/translations/, or keys of the locales object in config.js).

Describe alternatives you've considered

Additional context

It may be useful to check out the existing script at generateHeadingID.js as an example to work off.

Judging Criteria

The prize will be awarded to the first valid submission.

[samajammin]

@think-in-universe you might like this bounty 😄

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 75.0 DAI (75.0 USD @ $1.0/DAI) attached to it as part of the ethereum fund.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $87,690.13 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work has been started.

These users each claimed they can complete the work by 264 years, 8 months from now.
Please review their action plans below:

1) sebastiantf has started work.

will develop the script. Have experience in Javascript
2) antodp has started work.

Will build the script according to the bounty description

Learn more on the Gitcoin Issue Details page.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work for 75.0 DAI (75.0 USD @ $1.0/DAI) has been submitted by:

1. @antodp

@samajammin please take a look at the submitted work:

• PR by @antodp

---

• Learn more on the Gitcoin Issue Details page
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $87,674.98 more funded OSS Work available on the Gitcoin Issue Explorer

[samajammin]

Solved in #939. Thanks again @antodp!

[think-in-universe]

@samajammin thanks for invitation 😄

it seems already done. thank you guys for the quick work~

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

The funding of 75.0 DAI (75.0 USD @ $1.0/DAI) attached to this issue has been approved & issued to @antodp.

• Learn more on the Gitcoin Issue Details page
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $87,314.09 more funded OSS Work available on the Gitcoin Issue Explorer