From 4ecad2f54b0f8f1b7f63e780a5f9f532af03f982 Mon Sep 17 00:00:00 2001 From: chris del Date: Mon, 18 Nov 2024 09:22:58 -0600 Subject: [PATCH] #1683 request changes work --- .github/scripts/get-contributing.sh | 11 ++++++----- CONTRIBUTING.md | 6 +++--- en/resources/contributing.md | 4 ++-- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/scripts/get-contributing.sh b/.github/scripts/get-contributing.sh index d61494cfd1..6bae4e4100 100755 --- a/.github/scripts/get-contributing.sh +++ b/.github/scripts/get-contributing.sh @@ -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. @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 464232f0c9..28e18b5b53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -131,7 +131,7 @@ 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. @@ -139,7 +139,7 @@ To translate expressjs.com into a new language, follow these steps: 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 @@ -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). diff --git a/en/resources/contributing.md b/en/resources/contributing.md index faaa5523a0..70775b6381 100644 --- a/en/resources/contributing.md +++ b/en/resources/contributing.md @@ -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. @@ -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}