CONTRIBUTING.md : adds detail around internal linking for translations#356
Merged
jnewbery merged 1 commit intobitcoinops:masterfrom Feb 26, 2020
Conversation
jnewbery
reviewed
Feb 26, 2020
CONTRIBUTING.md
Outdated
| - For blog posts, place the file in `_posts/<language code>/` | ||
| - Set the `lang` field to `<language code>` | ||
| - Append `-<language code>` to both the `slug` and `name` fields | ||
| - When linking internally, link to the appropriate translation, if one is available. |
Contributor
There was a problem hiding this comment.
s/linking internally/linking to material on the Optech site/ for clarity.
CONTRIBUTING.md
Outdated
| - When linking to a specific header/bullet within a page, #anchor links are [automatically generated](https://github.com/bitcoinops/bitcoinops.github.io/blob/master/_plugins/auto-anchor.rb). | ||
| - Due to [limitations](https://github.com/bitcoinops/bitcoinops.github.io/pull/349) | ||
| in the automatic anchoring process, some languages [need HTML comments | ||
| inserted](https://github.com/bitcoinops/bitcoinops.github.io/commit/4e450d1a1f72219ec50ad91edae605647164d25d#diff-435f99f277721eff9e2f244149575f41R41) |
Contributor
There was a problem hiding this comment.
I suggest "some languages need HTML comments inserted. See for example the <!--1--> comment in this Japanese newsletter." to be absolutely clear about what you're demonstrating in the link.
Contributor
Author
There was a problem hiding this comment.
I think that’s clearer, thanks for the suggestion. Changed.
0296c51 to
e0f3e91
Compare
jnewbery
reviewed
Feb 26, 2020
CONTRIBUTING.md
Outdated
| - Due to [limitations](https://github.com/bitcoinops/bitcoinops.github.io/pull/349) | ||
| in the automatic anchoring process, some languages need HTML comments | ||
| inserted into the header/bullet to ensure a unique anchor is generated. | ||
| For example, see the <!--1--> [comment](https://github.com/bitcoinops/bitcoinops.github.io/commit/4e450d1a1f72219ec50ad91edae605647164d25d#diff-435f99f277721eff9e2f244149575f41R41) |
Contributor
There was a problem hiding this comment.
oops. Looks like this comment is commented out in the markdown. I think you can surround it with backticks to get it to display.
Contributor
Author
There was a problem hiding this comment.
Missed that you’re right. Fixup commit pushed.
e0f3e91 to
9616015
Compare
Contributor
|
Thanks Schmidty |
Merged
Walpurga03
added a commit
to Walpurga03/bitcoinops.github.io
that referenced
this pull request
Jun 14, 2025
bitschmidty
pushed a commit
that referenced
this pull request
Jun 14, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #354