Skip to content

Commit b45f493

Browse files
JoseJPRnschonnizekeTsuna-mi
authored
Feature: Differentiating the way to Contribute / Introductory guide for translators (#3158)
* Improve position and description workflow contribute * Remove phrase innecesary * Improve titles * Update Translation reference .md file Co-authored-by: Nick Schonning <nschonni@gmail.com> * test * Hi * Update README.md Co-authored-by: Zeke Sikelianos <zeke@github.com> * Update README.md Co-authored-by: Zeke Sikelianos <zeke@github.com> * test * a * test * test * Include husky npm dependence and include git-hook for load changed files into locale folder. * Change script name * Change test from locale file * Include git hook again * Remove husky for create new pullrequest * Change version linkinator dependence for error. * Update README.md Co-authored-by: Ana Gamito <imaginarte3d@gmail.com> Co-authored-by: Nick Schonning <nschonni@gmail.com> Co-authored-by: Zeke Sikelianos <zeke@github.com> Co-authored-by: Ana Gamito <imaginarte3d@gmail.com>
1 parent b85ec39 commit b45f493

2 files changed

Lines changed: 196 additions & 8 deletions

File tree

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ This repo's issues section has become the primary home for the Website WG's coor
1515

1616
## Contributing
1717

18+
There are two ways to contribute to this project. The first is **submitting new features or fixing bugs** and the second is **translating content to other languages**.
19+
20+
In both cases the workflow is different, please check how it is done in each case.
21+
22+
### To submit a new feature or a bugfix
23+
1824
Please contribute! There are plenty of [good first issues](https://github.com/nodejs/nodejs.org/labels/good%20first%20issue) to work on. To get started, you have to [fork](https://github.com/nodejs/nodejs.org/fork) this repo to your own GitHub account first. Then open up a terminal on your machine and enter the following commands:
1925

2026
```bash
@@ -28,7 +34,17 @@ This will start the development server on `http://localhost:8080/en/`. This shou
2834

2935
If you want to submit a new feature or a bugfix, the best way is to create the changes in a separate branch, e.g.: `git checkout -b feature/mycoolfeature`. This will make it easier for you to submit a pull request and get your feature merged.
3036

31-
### Layout
37+
### To translate content into other languages
38+
39+
If you want to help translate to other languages or improve existing translations, it isn't necessary to work from Github. You can and should do it through Crowdin, this is the correct workflow.
40+
41+
Crowdin is an online tool that facilitates the user experience for the translator, here is more information:
42+
43+
Website translations are handled via [Crowdin](https://crowdin.com/project/nodejs-website).
44+
45+
To help with localization, please read the [TRANSLATION](TRANSLATION.md) guide.
46+
47+
## Layout
3248

3349
* Page templates are in `/layouts`
3450
* Global styles are in `/layouts/css`
@@ -40,19 +56,19 @@ If you want to submit a new feature or a bugfix, the best way is to create the c
4056
* The top of each Markdown file is a block of YAML for page specific localization information that is passed to various templates.
4157
* The bulk of the Markdown content for each page is referenced as `{{{content}}}` in the corresponding template.
4258

43-
### Serve/Build Options
59+
## Serve/Build Options
4460

4561
* `DEFAULT_LOCALE={{locale}} npm run serve` builds only the files present in the specified locale folder (will display 404 if file is not present)
4662
* `DEFAULT_LOCALE={{locale}} npm run serve -- --preserveLocale` builds the files present in the specified locale folder and adds the pages present in the English locale that are missing.
4763
* `npm run serve` builds all languages and returns 404 when a file is not present in the current locale
4864
* `npm run serve -- --preserveLocale` builds all languages and adds the pages present in the English locale that are missing.
4965
* Multiple locales can be built by using comma separated values in the `DEFAULT_LOCALE` variable. i.e: `DEFAULT_LOCALE=en,es,it`
5066

51-
### Deployment
67+
## Deployment
5268

5369
Full set up is in <https://github.com/nodejs/build/tree/master/setup/www> minus secrets and certificates. The webhook is setup on GitHub for this project and talks to a small Node server on the host which does the work. See the [github-webhook](https://github.com/rvagg/github-webhook) package for this.
5470

55-
### Content vs. Code
71+
## Content vs. Code
5672

5773
The Website Working Group is primarily concerned with the code and overall structure of the website.
5874

@@ -61,7 +77,3 @@ The Website WG defers to these WGs on matters of content and routinely adds coll
6177
working groups as they add and improve content on the website. In other words, the Website WG is not
6278
an *editorial* Working Group except when no other Working Group has taken responsibility for a
6379
content area.
64-
65-
### Localization
66-
67-
Website translations are handled via [Crowdin](https://crowdin.com/project/nodejs-website). To help with localization, please read the [TRANSLATION](https://github.com/nodejs/nodejs.org/blob/master/TRANSLATION.md) guide.

package-lock.json

Lines changed: 176 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)