Skip to content

Commit f74fbbf

Browse files
Merge remote-tracking branch 'origin/dev' into refactor/storybook-proj-docs-and-unification
2 parents 1b725c0 + 1533dcb commit f74fbbf

File tree

952 files changed

+21003
-19176
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

952 files changed

+21003
-19176
lines changed

.all-contributorsrc

Lines changed: 536 additions & 2 deletions
Large diffs are not rendered by default.

.github/ISSUE_TEMPLATE/suggest_layer2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ body:
100100
id: layer_2_dapp_ecosystem
101101
attributes:
102102
label: Link to dapp ecosystem (if applicable)
103-
description: "Please provide a link to the dapp ecosystem. (ex: https://portal.arbitrum.one/, https://www.optimism.io/apps/all)"
103+
description: "Please provide a link to the dapp ecosystem. (ex: https://portal.arbitrum.io/, https://www.optimism.io/apps)"
104104
- type: input
105105
id: layer_2_token_contract_list
106106
attributes:

.github/workflows/get-crowdin-contributors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ jobs:
5959
6060
- name: Create Pull Request
6161
run: |
62-
gh auth login --with-token <<< ${{ secrets.GITHUB_TOKEN }}
62+
gh auth login --with-token ${{ secrets.GITHUB_TOKEN }}
6363
gh pr create --base dev --head "automated-update-${{ env.TIMESTAMP }}" --title "Update translation contributors from Crowdin - ${{ env.READABLE_DATE }}" --body-file pr_body.txt

.github/workflows/get-translation-progress.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ jobs:
6060
6161
- name: Create Pull Request
6262
run: |
63-
gh auth login --with-token <<< ${{ secrets.GITHUB_TOKEN }}
63+
gh auth login --with-token ${{ secrets.GITHUB_TOKEN }}
6464
gh pr create --base dev --head "automated-update-${{ env.TIMESTAMP }}" --title "Update translation progress from Crowdin - ${{ env.READABLE_DATE }}" --body-file pr_body.txt
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Import community events
2+
3+
on:
4+
schedule:
5+
- cron: "0 0 * * SUN" # Runs every Sunday at midnight
6+
workflow_dispatch:
7+
8+
jobs:
9+
create_pr:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Check out code
13+
uses: actions/checkout@master
14+
15+
- name: Set up Node.js
16+
uses: actions/setup-node@v3
17+
with:
18+
node-version: 18
19+
20+
- name: Install dependencies
21+
run: yarn install
22+
23+
- name: Set up git
24+
run: |
25+
git config --global user.email "[email protected]"
26+
git config --global user.name "GitHub Action"
27+
28+
- name: Generate timestamp and readable date
29+
id: date
30+
run: |
31+
echo "TIMESTAMP=$(date +'%Y%m%d%H%M%S')" >> $GITHUB_ENV
32+
echo "READABLE_DATE=$(date +'%B %-d')" >> $GITHUB_ENV
33+
34+
- name: Fetch latest dev and create new branch
35+
run: |
36+
git fetch origin dev
37+
git checkout -b "automated-update-${{ env.TIMESTAMP }}" origin/dev
38+
39+
- name: Run script
40+
run: yarn events-import
41+
env:
42+
GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
43+
44+
- name: Commit and push
45+
run: |
46+
git add -A
47+
git commit -m "Update community events"
48+
git push origin "automated-update-${{ env.TIMESTAMP }}"
49+
50+
- name: Create PR body
51+
run: |
52+
echo "This PR was automatically created to update community events from external community spreadsheet." > pr_body.txt
53+
echo "This workflows runs every Sunday at 00:00 (UTC)." >> pr_body.txt
54+
echo "Source: https://docs.google.com/spreadsheets/d/1NEu_FCc1hnGAuRgPmbXXpf0h2lCrCOlMKbbFEqgkVDQ" >> pr_body.txt
55+
56+
- name: Create Pull Request
57+
run: |
58+
gh auth login --with-token ${{ secrets.GITHUB_TOKEN }}
59+
gh pr create --base dev --head "automated-update-${{ env.TIMESTAMP }}" --title "Update community events from external spreadsheet - ${{ env.READABLE_DATE }}" --body-file pr_body.txt

.github/workflows/issue-triage-label.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ jobs:
1717
issue_number: context.issue.number,
1818
owner: context.repo.owner,
1919
repo: context.repo.repo,
20-
labels: ["needs-triage"]
20+
labels: ["needs triage 📥"]
2121
})

README.md

Lines changed: 88 additions & 30 deletions
Large diffs are not rendered by default.

docs/github-issue-triage-process.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ This documentation outlines the current process for how issues are triaged for t
44

55
## Issue creation process
66

7-
Whenever a new issue is opened, it will automatically be labeled with a `needs-triage` label. The `needs-triage` label means that the core team needs to look at the issue, and nobody should work on it yet to avoid unnecessary work. This label will be removed after the issue has been triaged by a core contributor.
7+
Whenever a new issue is opened, it will automatically be labeled with a `needs triage 📥` label. The `needs triage 📥` label means that the core team needs to look at the issue, and nobody should work on it yet to avoid unnecessary work. This label will be removed after the issue has been triaged by a core contributor.
88

99
## Triage process
1010

11-
The core team will review issues with the `needs-triage` label within 5 days. In order for an issue to be considered triaged, one of the following will need to happen:
11+
The core team will review issues with the `needs triage 📥` label within 5 days. In order for an issue to be considered triaged, one of the following will need to happen:
1212

1313
1. The issue will be closed if it is not needed, a duplicate, or spam.
1414
2. If an issue needs more discussion, the `GH grooming` tag will be added, and the issue will be discussed next GitHub grooming. After this call, action items will be recorded and the issue will be considered triaged.
1515
3. The issue is labeled with the appropriate tags for work needed (ex: `design required`, `dev required`, etc.) and open it up for assignment. More on this below.
1616

17-
After an issue has been triaged, the `needs-triage` label will be removed from the issue.
17+
After an issue has been triaged, the `needs triage 📥` label will be removed from the issue.
1818

1919
## Assignment process
2020

docs/header-ids.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Custom header IDs for markdown documents
2+
3+
Html ID attributes are used to create links to specific sections of a document. In markdown, **custom header IDs** should be assigned to all header lines (lines that begin with one-or-more hash marks, `#`).
4+
5+
## Markdown syntax
6+
7+
A custom heading ID should follow these rules:
8+
9+
- Placed at the end of a heading line, preceded by a space, followed by a line break
10+
- Wrapped in curly braces
11+
- Starts with a hash-mark
12+
- Uses kebab-case string
13+
- Unique for the current page
14+
15+
For example:
16+
17+
```markdown
18+
## My heading {#my-heading}
19+
20+
### A subheading {#a-subheading}
21+
22+
#### Or a longer title that can be shortened {#long-heading}
23+
```
24+
25+
Note that for short headers, simply lowercasing and using hyphens instead of spaces is sufficient. For longer headers, a shortened concise version of the header is encouraged. Must not repeat the same ID on the same page.
26+
27+
## How are these used?
28+
29+
When these headers are rendered, they come with a link icon attached to it that can be used to quickly link to that section of the document.
30+
31+
Extending the above example, if we wanted to link to the `A subheading` section of the above document (for example living at path `/docs`), you could use the link`/docs#a-subheading` to link directly to that section.
32+
33+
See a live example on ethereum.org: [https://ethereum.org/en/developers/docs/blocks/#block-anatomy](https://ethereum.org/en/developers/docs/blocks/#block-anatomy)
34+
35+
## When to use custom header IDs
36+
37+
### English content
38+
39+
These should be created for header on every new English markdown document.
40+
41+
### Translated content
42+
43+
English files are uploaded to Crowdin for translation. Header ID's should be _inherited_ from the English version, and remain unchanged during translation.
44+
45+
This is to ensure that the translated content can be linked to from other documents and external links, without breaking the path. This is similar to why path and filenames are not translated, but remain in English to simplify linking and referencing.
46+
47+
See a live example on ethereum.org: [https://ethereum.org/es/developers/docs/blocks/#block-anatomy](https://ethereum.org/en/developers/docs/blocks/#block-anatomy)
48+
49+
Notice the header ID is still in English (`#block-anatomy`), but links to the Spanish (`/es/`) version of the site, at the correct section.
50+
51+
## When are these not needed?
52+
53+
Markdown files in the repo `/docs` (such as this one) do not require custom header IDs, as they are not yet displayed on the website, and do not have translated versions.

package.json

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ethereum-org-website",
3-
"version": "8.0.0",
3+
"version": "8.4.0",
44
"private": true,
55
"scripts": {
66
"dev": "next dev",
@@ -17,6 +17,7 @@
1717
"chromatic": "chromatic --project-token fee8e66c9916",
1818
"crowdin-clean": "rm -rf .crowdin && mkdir .crowdin",
1919
"crowdin-import": "ts-node src/scripts/crowdin-import.ts",
20+
"events-import": "ts-node -O '{ \"module\": \"commonjs\" }' src/scripts/events-import.ts",
2021
"markdown-checker": "ts-node -O '{ \"module\": \"commonjs\" }' src/scripts/markdownChecker.ts"
2122
},
2223
"dependencies": {
@@ -27,7 +28,6 @@
2728
"@emotion/styled": "^11.11.0",
2829
"@radix-ui/react-navigation-menu": "^1.1.4",
2930
"@socialgouv/matomo-next": "^1.8.0",
30-
"clipboard": "^2.0.11",
3131
"embla-carousel-react": "^7.0.0",
3232
"ethereum-blockies-base64": "^1.0.2",
3333
"focus-trap-react": "^10.2.3",
@@ -37,7 +37,7 @@
3737
"i18next": "^23.6.0",
3838
"lodash.merge": "^4.6.2",
3939
"lodash.shuffle": "^4.2.0",
40-
"luxon": "^3.4.3",
40+
"lodash.union": "^4.6.0",
4141
"next": "13.4.8",
4242
"next-i18next": "^14.0.3",
4343
"next-mdx-remote": "^3.0.8",
@@ -50,7 +50,7 @@
5050
"react-i18next": "^13.3.1",
5151
"react-icons": "^4.10.1",
5252
"react-lite-youtube-embed": "^2.4.0",
53-
"react-select": "^4.3.0",
53+
"react-select": "5.8.0",
5454
"reading-time": "^1.5.0",
5555
"recharts": "^2.7.3",
5656
"remark-gfm": "^3.0.1",
@@ -67,7 +67,6 @@
6767
"@storybook/testing-library": "0.2.2",
6868
"@svgr/webpack": "^8.1.0",
6969
"@types/hast": "^3.0.0",
70-
"@types/luxon": "^3.3.2",
7170
"@types/node": "^20.4.2",
7271
"@types/react": "^18.2.15",
7372
"@types/react-dom": "^18.2.7",
@@ -86,7 +85,7 @@
8685
"storybook": "7.6.6",
8786
"storybook-react-i18next": "^2.0.9",
8887
"ts-node": "^10.9.1",
89-
"typescript": "^5.1.6",
88+
"typescript": "^5.4.2",
9089
"unified": "^10.0.0",
9190
"unist-util-visit": "^5.0.0"
9291
},

0 commit comments

Comments
 (0)