Skip to content

Commit

Permalink
expressjs#1683 request changes work
Browse files Browse the repository at this point in the history
  • Loading branch information
chris del committed Nov 18, 2024
1 parent 7b37a32 commit 4ecad2f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
11 changes: 6 additions & 5 deletions .github/scripts/get-contributing.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

DEST="../../en/resources/contributing.md"
DEST="./en/resources/contributing.md"

# This script replaces the contents of a section with the contents from
# the annotated source address.
Expand Down Expand Up @@ -44,12 +44,13 @@ while IFS= read -r line; do

if [[ -n "$local" ]]; then
cat "$local" | \
# remove the top # headers from cp file
# remove the top 1# headers from cat'd file
sed -En '/^##|^[^#]/,$p' | \
# remove any starting w NOTE: lines
# remove any ln starting w 'NOTE: lines'
sed -E '/^[NOTE:*]/d' | \
# remove any lines with Not the Express JS Framework string
sed -E '/Not the Express JS Framework/I,$d'
# remove any lines with 'Not the Express JS Framework'
sed -E '/Not the Express JS Framework/I,$d' | \
sed -E 's/> \[!IMPORTANT\]/> **IMORTANT:** /g'
echo
elif [[ -n "$src" ]]; then
echo
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,15 @@ If you find a translation is missing from the list you can create a new one.
To translate expressjs.com into a new language, follow these steps:

1. Clone the [`expressjs.com`](https://github.com/expressjs/expressjs.com) repository.
2. Create a directory for the language of your choice using its [ISO 639-1 code](http://www.loc.gov/standards/iso639-2/php/code_list.php) as its name.
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.
3. Copy `index.md`, `api.md`, `starter/`, `guide/`, `advanced/`, `resources/`, `4x/`, and `3x/`, to the language directory.
4. Remove the link to 2.x docs from the "API Reference" menu.
5. Update the `lang` variable in the copied markdown files.
6. Update the `title` variable in the copied markdown files.
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.
8. Create the announcement file for the language in the `_includes/` directory.
9. Make sure to append `/{{ page.lang }}` to all the links within the site.
10. Update the `CONTRIBUTING.md` and the `.github/workflows/translation.yml` files with the new language.
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.

### Adding Page and Section Translations

Expand All @@ -149,6 +149,6 @@ If you contribute a page or section translation, please reference the original P

## We're the Express JS Framework's Documentation Team - Not the Express JS Framework

If you are looking for the repository for the **Express JS Framework**, you've hopefully noticed by now that you've come to the wrong place. This page is only for issues related to the this website: [http://expressjs.com](http://expressjs.com).
If you are looking for the repository for the **Express JS Framework**, you've hopefully noticed by now that you've come to the wrong place. This page is only for issues related to the this website: [https://expressjs.com](https://expressjs.com).

For more information on contributing to Express itself, check our out our [Contributing to Express](/{{ page.lang }}/resources/contributing.html) page. For anything else, visit the repository [https://github.com/expressjs/express](https://github.com/expressjs/express).
4 changes: 2 additions & 2 deletions en/resources/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ redirect_from: "/resources/community.html"

# Contributing to Express

### Looking to contribute to expressjs.com? Click [here](#contributing-to-expressjscom).
### Looking to contribute to expressjs.com? Click [here](#expressjs-website-contributing).

Express and the other projects in the [expressjs organization on GitHub](https://github.com/expressjs) are projects of the [OpenJs Foundation](https://openjsf.org/).
These projects are governed under the general policies and guidelines of the Node.js Foundation along with the additional guidelines below.
Expand Down Expand Up @@ -375,6 +375,6 @@ We are currently working on a new version of the security model, the most update
If you have suggestions on how this process could be improved please submit a
pull request.

# Contributing to Expressjs.com
# Contributing to Expressjs.com {#expressjs-website-contributing}

<!-- LOCAL: expressjs/expressjs.com ../../CONTRIBUTING.md -->

0 comments on commit 4ecad2f

Please sign in to comment.