Skip to content

Commit

Permalink
Minor README fixes and dependency updates (dart-lang#5519)
Browse files Browse the repository at this point in the history
  • Loading branch information
parlough authored and Tony Sansone committed Feb 20, 2024
1 parent 6910197 commit 45ce1cb
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 43 deletions.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Fixes <Replace with issue link>
---

- [ ] I’ve reviewed the contributor guide and applied the relevant portions to this PR.
- [ ] This PR doesnt contain automatically generated corrections or text (Grammarly, LLMs, and similar).
- [ ] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesnt use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person).
- [ ] This PR doesn't contain automatically generated corrections or text (Grammarly, LLMs, and similar).
- [ ] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn't use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person).
- [ ] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer.

<details>
Expand Down
17 changes: 5 additions & 12 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,8 @@
# Set update schedule for GitHub Actions
# See https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot
# See https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot

version: 2
updates:
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "daily"
labels:
- "auto.dependencies"
- "auto.docker"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
Expand All @@ -23,15 +16,15 @@ updates:
schedule:
interval: "daily"
allow:
- dependency-type: "production"
- dependency-type: "direct"
labels:
- "auto.dependencies"
- "auto.npm"
- "lang.javascript"
- package-ecosystem: 'gitsubmodule'
directory: '/'
- package-ecosystem: "gitsubmodule"
directory: "/"
schedule:
interval: 'daily'
interval: "daily"
labels:
- "auto.dependencies"
- "auto.submodules"
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ feel free to ask any questions you have on the same issue.

To update this site, fork the repo, make your changes,
and generate a pull request.
For simple changes (such as style and typo fixes),
For small, contained changes (such as style and typo fixes),
you probably don't need to build this site.
Often you can make changes using the GitHub UI.
We can stage the changes automatically in your pull request.
Expand Down Expand Up @@ -95,21 +95,19 @@ and then submit a PR from that fork.
Once you have a fork (or you're a Dart org member),
_choose one_ of the following submodule-cloning techniques:

- Clone the repo and its submodule at the same time
using the `--recurse-submodules` option:
1. Clone the repo and its submodule at the same time
using the `--recurse-submodules` option:

```terminal
git clone --recurse-submodules https://github.com/dart-lang/site-www.git
```

*OR*
```terminal
git clone --recurse-submodules https://github.com/dart-lang/site-www.git
```

- If you've already cloned the repo without its submodule,
then run this command from the repo root:
2. If you've already cloned the repo without its submodule,
then run this command from the root of the repository:

```terminal
git submodule update --init --recursive
```
```terminal
git submodule update --init --recursive
```

> [!NOTE]
> At any time during development
Expand Down Expand Up @@ -170,8 +168,7 @@ following the instructions in [Get the prerequisites](#get-the-prerequisites).

6. View your changes in the browser by navigating to <http://localhost:4000>.

> [!NOTE]
> The port might be different if `4000` is taken.
Note the port might be different if `4000` is taken.

To instead view the source of generated site files,
check the `_site` directory.
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
},
"engines": {
"node": ">=20.10.0",
"pnpm": ">=8.14.0"
"pnpm": ">=8.14.1"
},
"packageManager": "pnpm@8.14.3",
"dependencies": {
"bootstrap-scss": "^4.6.2"
},
"devDependencies": {
"@11ty/eleventy": "3.0.0-alpha.4",
"firebase-tools": "^13.0.3",
"firebase-tools": "^13.2.1",
"hast-util-from-html": "^2.0.1",
"hast-util-select": "^6.0.2",
"hast-util-to-html": "^9.0.0",
Expand All @@ -37,6 +37,6 @@
"markdown-it-deflist": "^3.0.0",
"markdown-it-table": "^4.1.1",
"sass": "^1.70.0",
"shikiji": "^0.10.0"
"shikiji": "^0.10.2"
}
}
22 changes: 11 additions & 11 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 45ce1cb

Please sign in to comment.