Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 0 additions & 67 deletions docs/help-to-translate.md

This file was deleted.

78 changes: 78 additions & 0 deletions docs/help-us-translate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Translating the DAppNode Documentation
---
So far we have added two additional languages to the documentation. If you want to help us by translating the documentation, you can do that via the Crowdin platform as shown below.

## Project Overview

Access our [Crowdin project here](https://crowdin.com/project/dappnodedocs)

Prerequisites for doing so:

- A Crowdin account

### Available languages
On the project page you will see the available languages you can contribute to:

<p align="center">
<img src="../../../../img/translation_1.png"/>
</p>

### Files to be translated

Once you have selected the language, you will see a tree-style directory view of all the files containing the documentation. You can also see two additional statistics:

- Words translated: words that have been translated by someone. They represent the <font color="blue">**blue part**</font> of the bar.
- Words approved: words that have been translated and someone confirmed that the translation is accurate. They represent the <font color="green">**green part**</font> of the bar.

Below you can see an example for the spanish translation.

<p align="center">
<img src="../../../../img/translation_2.png"/>
</p>

## Translating and voting

### Selecting a file
Now you can navigate to a file that you wish to translate and click on the name of the file (**intro.md** in the example).

<p align="center">
<img src="../../../../img/translation_3.png"/>
</p>

Here we can see 2 different highlighted sections:

- **<font color="red">Red</font>** highlight: Text that has not been translated yet.
- **<font color="green">Green</font>** highlight: Text that has already been translated.

On this page you can translate the content and/or vote/approve a translation.

### Adding your translation to the documentation

A file is divided into strings or phrases. You need to click on the string or phrase you wish to translate.

If I want to translate the following string: `This documentation has 4 types of content depending on what you want to do:`, I click on it and the text shows up in the `Source string` box:

<p align="center">
<img src="../../../../img/translation_4.png"/>
</p>

Translate the sentence on the right panel, under `Enter translation here`, and click on the SAVE button.

### Maintaining the formatting and style of the original text

If the original text has style tags like those in the example:
`<strong x-id="1">Get Started</strong> : you can find what you need to run a DAppNode, hardware recommendations or how to get DAppNode hardware.`

You will need to keep those tags and make them work in your translation.

<p align="center">
<img src="../../../../img/translation_5.png"/>
</p>

To do so, copy those tags `<strong x-id="1">Get Started</strong>` and change the content inside of them. Rearrange them if needed. In this example, the result would be something like this:

`<strong x-id="1">Iniciación</strong> : you can find what you need to run a DAppNode, hardware recommendations or how to get DAppNode hardware.`

### Approve existing translations or submit a change

In case there's already an existing translation, you will be able to suggest an alternative translation or to approve the translation. To do this, select the green/blue highlighted string and upvote/downvote the translation; or suggest an alternative translation.
12 changes: 7 additions & 5 deletions docs/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ title: User Guide
slug: "/"
---

Wellcome to the DAppNode user guide.
If you have just installed or bought a DAppNode, the section quick start will help you to do the first step on your DAppNode.
Welcome to the DAppNode user guide.
===
---
If you have just installed DAppNode on your own hardware or bought a DAppNode from our [store](https://shop.dappnode.io/), the [Quick Start section](/user/quick-start/home) will help you through the first steps with your DAppNode.

If you want to validate or know how to do cool stuff go to the guides section.
If you want to run your own validator, access decentralised apps or learn how to do cool stuff on your DAppNode visit the [Guides section](/user/guides).

If you have some problem or doubt about dappnode, go to the FAQS.
If you have problems with your DAppNode or want to get in touch with us, please take a look at the [FAQs](/user/faq/general).

The product manual will show you what does every button and part of the UI.
The [product manual](/user/product-manual/dashboard) aims to give you an overview of the whole DAppNode interface, accompanied by a functional explanation of that part of the UI.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ module.exports = {
type: 'localeDropdown',
dropdownItemsAfter: [
{
to: '/help-to-translate',
to: '/help-us-translate',
label: 'Help Us Translate',
},
],
Expand Down Expand Up @@ -62,7 +62,7 @@ module.exports = {
},
{
label: 'Discord',
href: 'https://discord.com/invite/c28an8dA5k',
href: 'https://discord.com/invite/dappnode',
},
{
label: 'Twitter',
Expand Down
4 changes: 2 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ module.exports = {
},
{
type: 'category',
label: 'FAQS',
label: 'FAQ',
items: [
{
type: 'autogenerated',
dirName: 'user/faqs',
dirName: 'user/faq',
},
],
},
Expand Down