Skip to content

Commit b9d72b9

Browse files
bjohansebasCopilot
bjohansebas
and
Copilot
authored
docs: new process for translate page (#1805)
* docs: new process for translate page * docs: update link in contributing guide for local setup * Update CONTRIBUTING.md * Update README.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 4ea8ef5 commit b9d72b9

File tree

2 files changed

+53
-97
lines changed

2 files changed

+53
-97
lines changed

‎CONTRIBUTING.md

Lines changed: 25 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,31 @@
22

33
### The Official Documentation of the Express JS Framework
44

5-
This is the contribution documentation for the [Expressjs.com](https://github.com/expressjs/expressjs.com) website.
5+
This is the contribution documentation for the [expressjs.com](https://github.com/expressjs/expressjs.com) website.
66

77
>[!NOTE]
88
> This is not the repo for Express JS framework. To contribute to the _[Express JS framework](https://github.com/expressjs/express_)_, check out the [Github repo contributing page](https://github.com/expressjs/express/blob/master/Contributing.md) or the website's [Contributing to Express](https://expressjs.com/en/resources/contributing.html) page.
99
1010

1111
#### Need some ideas? These are some typical issues.
1212

13-
1. **Website issues**:
14-
If you see anything on the site that could use a tune-up, think about how to fix it.
15-
13+
1. **Website issues**: If you see anything on the site that could use a tune-up, think about how to fix it.
1614
- Display or screen sizing problems
1715
- Mobile responsiveness issues
1816
- Missing or broken accessibility features
1917
- Website outages
2018
- Broken links
2119
- Page structure or user interface enhancements
2220

23-
24-
2. **Content Issues**:
25-
Fix anything related to site content or typos.
21+
2. **Content Issues**: Fix anything related to site content or typos.
2622
- Spelling errors
2723
- Incorrect/outdated Express JS documentation
2824
- Missing content
2925

30-
3126
3. **Translation Issues**: Fix any translation errors or contribute new content.
3227
- Fix spelling errors
3328
- Fix incorrect/poorly translated words
34-
- Translate new content
35-
> [!IMPORTANT]
36-
> All translation submissions are currently paused. See this [notice](#notice-we-have-paused-all-translation-contributions) for more information.
37-
38-
- Check out the [Contributing translations](#contributing-translations) section below for a contributing guide.
29+
- Check out the [Contributing translations](#contributing-translations) section below for a contributing guide.
3930

4031
#### Want to work on a backlog issue?
4132

@@ -45,6 +36,7 @@ We often have bugs or enhancements that need work. You can find these under our
4536

4637
If you've found a bug or a typo, or if you have an idea for an enhancement, you can:
4738
- Submit a [new issue](https://github.com/expressjs/expressjs.com/issues/new/choose) on our repo. Do this for larger proposals, or if you'd like to discuss or get feedback first.
39+
4840
- Make a [Github pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). If you have already done work and it's ready to go, feel free to send it our way.
4941

5042
## Getting Started
@@ -65,7 +57,9 @@ So you've found a problem that you want to fix, or have a site enhancement you w
6557

6658
Clone the repo and get the code:
6759

68-
git clone https://github.com/expressjs/expressjs.com.git
60+
```sh
61+
git clone https://github.com/expressjs/expressjs.com.git
62+
```
6963

7064
After you've got the code you're ready to start making your changes!
7165

@@ -91,64 +85,42 @@ follow the specific instructions for [How to write a blog post.](https://express
9185
**CSS or Javascript**
9286
- All css and js files are kept in `css` and `js` folders on the project root.
9387

94-
The Express JS website is build using [Jeykyll](https://jekyllrb.com/) and is hosted on [Github Pages](https://pages.github.com/).
88+
The Express JS website is built using [Jekyll](https://jekyllrb.com/) and is hosted on [Github Pages](https://pages.github.com/).
9589

9690
#### Step 3: Running the Application
9791

98-
9992
Now you'll need a way to see your changes, which means you'll need a running version of the application. You have two options.
100-
1. __Run Locally__: This gets the local version of the application up and running on your machine. Follow our [Local Setup Guide](https://github.com/expressjs/expressjs.com?tab=readme-ov-file#local-setup) to use this option.
93+
94+
>[!NOTE]
95+
>If you're only making changes to the content, you most likely won't need to run the site locally.
96+
97+
1. __Run Locally__: This gets the local version of the application up and running on your machine. Follow our [Local Setup Guide](https://github.com/expressjs/expressjs.com?tab=readme-ov-file#build-the-website-locally) to use this option.
10198
- This is the recommended option for moderate to complex work.
99+
102100
2. __Run using Deploy Preview__: Use this option if you don't want to bother with a local installation. Part of our continuous integration pipeline includes [Netlify Deploy Preview](https://docs.netlify.com/site-deploys/deploy-previews/).
103101
1. To use this you'll need to get your changes online - after you've made your first commit on your feature branch, make a *draft* pull request.
104102
2. After the build steps are complete, you'll have access to a __Deploy Preview__ tab that will run your changes on the web, rebuilding after each commit is pushed.
105103
3. After you are completely done your work and it's ready for review, remove the draft status on your pull request and submit your work.
106104

107105
## Contributing translations
108106

109-
#### Notice: We have paused all translation contributions.
110-
> [!IMPORTANT]
111-
> We are currently working toward a more streamlined translations workflow. As long as this notice is posted, we will _not_ be accepting any translation submissions.
112-
113-
We highly encourage community translations! We no longer have professional translations, and we believe in the power of our community to provide accurate and helpful translations.
107+
We use Crowdin to manage our translations in multiple languages and achieve automatic translation with artificial intelligence. Since these translations can be inefficient in some cases, we need help from the community to provide accurate and helpful translations.
114108

115109
The documentation is translated into these languages:
110+
111+
- Chinese Simplified (`zh-cn`)
112+
- Chinese Traditional (`zh-tw`)
116113
- English (`en`)
117-
- Spanish (`es`)
118114
- French (`fr`)
115+
- German (`de`)
119116
- Italian (`it`)
120-
- Indonesian (`id`)
121117
- Japanese (`ja`)
122118
- Korean (`ko`)
123119
- Brazilian Portuguese (`pt-br`)
124-
- Russian (`ru`)
125-
- Slovak (`sk`)
126-
- Thai (`th`)
127-
- Turkish (`tr`)
128-
- Ukrainian (`uk`)
129-
- Uzbek (`uz`)
130-
- Simplified Chinese (`zh-cn`)
131-
- Traditional Chinese (`zh-tw`)
132-
133-
### Adding New Full Site Translations
134-
135-
If you find a translation is missing from the list you can create a new one.
136-
137-
To translate Expressjs.com into a new language, follow these steps:
138-
139-
1. Clone the [`expressjs.com`](https://github.com/expressjs/expressjs.com) repository.
140-
2. Create a directory for the language of your choice using its [ISO 639-1 code](https://www.loc.gov/standards/iso639-2/php/code_list.php) as its name.
141-
3. Copy `index.md`, `api.md`, `starter/`, `guide/`, `advanced/`, `resources/`, `4x/`, and `3x/`, to the language directory.
142-
4. Remove the link to 2.x docs from the "API Reference" menu.
143-
5. Update the `lang` variable in the copied markdown files.
144-
6. Update the `title` variable in the copied markdown files.
145-
7. Create the header, footer, notice, and announcement file for the language in the `_includes/` directory, in the respective directories, and make necessary edits to the contents.
146-
8. Create the announcement file for the language in the `_includes/` directory.
147-
9. Make sure to append `/{{ page.lang }}` to all the links within the site.
148-
10. Update the [CONTRIBUTING.md](https://github.com/expressjs/expressjs.com/blob/gh-pages/CONTRIBUTING.md#contributing-translations) and the `.github/workflows/translation.yml` files with the new language.
149-
150-
### Adding Page and Section Translations
120+
- Spanish (`es`)
151121

152-
Many site translations are still missing pages. To find which ones we need help with, you can [filter for merged PRs](https://github.com/expressjs/expressjs.com/pulls?q=is%3Apr+is%3Aclosed+label%3Arequires-translation-es) that include the tag for your language, such as `requires-translation-es` for requires Spanish translation.
122+
### How to translate
153123

154-
If you contribute a page or section translation, please reference the original PR. This helps the person merging your translation to remove the tag from the original PR.
124+
1. Request to join the Express.js Website project on [Crowdin](https://express.crowdin.com/website)
125+
2. [Select the language you want to translate](https://support.crowdin.com/joining-translation-project/#starting-translation)
126+
3. [Start translating](https://support.crowdin.com/online-editor/)

‎README.md

Lines changed: 28 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,32 @@
22

33
This is the repository of the website [expressjs.com](https://expressjs.com). It is hosted directly from the repository as a [GitHub Pages](https://pages.github.com/) website.
44

5-
## Local Setup
5+
## Contributing
6+
7+
Any person who wants to contribute to the Website is welcome! Please read [Contributors' Guide](CONTRIBUTING.md) for more information on contributing to the Express.js documentation.
8+
9+
## Translations
10+
11+
If you're interested in contributing to the site's translations, you can find more information [here](https://github.com/expressjs/expressjs.com/blob/gh-pages/CONTRIBUTING.md#contributing-translations).
12+
13+
## Build the website locally
14+
15+
>[!NOTE]
16+
>If you're only making changes to the content, you most likely won't need to run the site locally.
17+
18+
To preview the website locally, we have two options: using Docker or using Bundler.
19+
20+
### Using Docker
621

7-
To preview the website locally:
22+
>[!TIP]
23+
> You can run `make help` to obtain detailed information on how to use our make commands.
24+
25+
1. Ensure that you have Docker and Make installed.
26+
1. Run `make build` to build the project.
27+
1. Run `make serve` to serve the project, this include live reloading so any change will be reflected (it can take a while, check the logs).
28+
1. Run `make clean` to remove the docker images and resources generated.
29+
30+
### Using Bundle
831

932
1. Install [Ruby and Bundler](https://help.github.com/articles/setting-up-your-pages-site-locally-with-jekyll/) if you don't have them already.
1033

@@ -15,6 +38,7 @@ To preview the website locally:
1538
```
1639

1740
1. Clone this repository by running the following command:
41+
1842
```sh
1943
$ git clone https://github.com/expressjs/expressjs.com.git
2044
```
@@ -35,46 +59,6 @@ To preview the website locally:
3559

3660
Then, load <http://localhost:4000> in your browser.
3761

38-
## Local Setup using Docker
39-
40-
>[!TIP]
41-
> You can run `make help` to obtain detailed information on how to use our make commands.
42-
43-
0. Ensure that you have Docker and Make installed.
44-
1. Run `make build` to build the project.
45-
2. Run `make serve` to serve the project, this include live reloading so any change will be reflected (it can take a while, check the logs).
46-
3. Run `make clean` to remove the docker images and resources generated.
47-
48-
## Formatting
49-
50-
Jekyll uses a variant of Markdown known as [Kramdown](https://kramdown.gettalong.org/quickref.html).
51-
52-
Jekyll uses the [Liquid template engine](https://shopify.github.io/liquid/) for templating.
53-
54-
You can use [GFM](https://kramdown.gettalong.org/parser/gfm.html) fenced code blocks for JavaScript; for example:
55-
56-
<pre>
57-
```js
58-
var express = require('express')
59-
var app = express()
60-
app.listen(3000)
61-
```
62-
</pre>
63-
64-
The result looks like this:
65-
66-
```js
67-
const express = require('express')
68-
const app = express()
69-
app.listen(3000)
70-
```
71-
72-
The default GitHub Pages syntax highlighting has been disabled in `_config.yml` to allow highlighting with [prism.js](https://prismjs.com/).
73-
74-
## Contributing
75-
76-
Please see the [Contributors' Guide](CONTRIBUTING.md) for more information on contributing to the Express JS documentation, including information on contributing translations.
77-
78-
## Why use Jekyll instead of an Express-based solution?
62+
## License
7963

80-
Jekyll comes built-in with GitHub Pages. Since we are already using GitHub Pages to host the website, it makes sense to leverage the capabilities it provides. It's all about using the right tool, for the right job, under the right circumstances.
64+
Content submitted to [expressjs.com](expressjs.com) is Creative Commons Attribution 4.0 International licensed, as found in the [LICENSE.md](LICENSE.md) file.

0 commit comments

Comments
 (0)