Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial migration of site to 11ty #5483

Merged
merged 15 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 0 additions & 7 deletions .devcontainer/devcontainer.json

This file was deleted.

6 changes: 0 additions & 6 deletions .dockerignore

This file was deleted.

8 changes: 0 additions & 8 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,6 @@

version: 2
updates:
- package-ecosystem: "bundler"
directory: "/"
schedule:
interval: "daily"
labels:
- "auto.dependencies"
- "auto.bundler"
- "lang.ruby"
- package-ecosystem: "docker"
directory: "/"
schedule:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
strategy:
fail-fast: false
matrix:
language: [ 'javascript', 'ruby' ]
language: [ 'javascript' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://git.io/codeql-language-support

Expand Down
37 changes: 27 additions & 10 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
- uses: dart-lang/setup-dart@fedb1266e91cf51be2fdb382869461a434b920a3
with:
sdk: ${{ matrix.sdk }}
- name: Fetch packages
- name: Fetch Dart packages
run: dart pub get
- name: Check Dart code formatting
run: dart run dart_site format-dart --check
Expand All @@ -57,25 +57,42 @@ jobs:
linkcheck:
name: Build site and check links
runs-on: ubuntu-latest
strategy:
fail-fast: false
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
with:
submodules: recursive
- run: make build
- uses: dart-lang/setup-dart@fedb1266e91cf51be2fdb382869461a434b920a3
with:
sdk: stable
- name: Fetch packages
- name: Fetch Dart packages
run: dart pub get
- name: Check for broken Markdown links
run: dart run dart_site check-link-references
- name: Validate the firebase.json file
run: dart run dart_site verify-firebase-json
- uses: pnpm/action-setup@ebcfd6995dade4b0104ac774445cef8b3b4635b0
with:
version: 8
- uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8
parlough marked this conversation as resolved.
Show resolved Hide resolved
with:
node-version: ${{ env.NODE_VERSION }}
- run: npm install -g [email protected]
cache: 'pnpm'
- name: Install node dependencies
run: pnpm install
- name: Build site
run: dart run dart_site build
- name: Check for broken Markdown links
run: dart run dart_site check-link-references
- name: Check internal site links are functional
run: dart run dart_site check-links
khanhnwin marked this conversation as resolved.
Show resolved Hide resolved

firebase-validate:
name: Validate Firebase configuration
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
with:
submodules: recursive
- uses: dart-lang/setup-dart@ca7e6fee45ffbd82b555a7ebfc236d2c86439f5b
with:
sdk: stable
- name: Fetch Dart packages
run: dart pub get
- name: Validate the firebase.json file
run: dart run dart_site verify-firebase-json
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
_asset_bundler_cache
_bookhtml
_cache/
_site/
.*-cache
Expand All @@ -10,8 +8,6 @@ _site/
.env*
.firebase
.idea
.packages
.pub
.spelling
.vscode
*.cache
Expand All @@ -25,6 +21,7 @@ build
firebase-debug.log
node_modules
pubspec.lock
package-lock.json
tmp

# Misc
Expand Down
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ Chris Buckett <[email protected]>
Michael Haubenwallner <[email protected]>
Victor Berchet <[email protected]>
Pradumna Saraf <[email protected]>
Parker Lougheed <[email protected]>
parlough marked this conversation as resolved.
Show resolved Hide resolved
29 changes: 16 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ You can contribute in a few ways.

* **[Report issues][].**

* **Fix known issues** (especially ones with the label **[help wanted][]** or
**[beginner][]**). These issues may or may not be easy to fix. Sometimes
* **Fix known issues.** These issues may or may not be easy to fix. Sometimes
they're issues that we don't have the expertise to fix, and we'd love to
work with a contributor who has the right skills.

Expand All @@ -37,11 +36,9 @@ More info:
* For more ways to contribute to Dart, see the
[dart-lang/sdk Contributing page][].

[beginner]: https://github.com/dart-lang/site-www/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22help%20wanted%22%20label%3Abeginner%20
[dart-lang/sdk Contributing page]: https://github.com/dart-lang/sdk/blob/main/CONTRIBUTING.md
[GitHub pull request]: https://docs.github.com/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
[GitHub pull request]: https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
[Google Developer Documentation Style Guide]: https://developers.google.com/style/
[help wanted]: https://github.com/dart-lang/site-www/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3A%22help%20wanted%22%20
[in the site-shared repo]: https://github.com/dart-lang/site-shared/blob/main/doc
[issue tracker]: https://github.com/dart-lang/site-www/issues
[on Flutter's Discord server]: https://github.com/flutter/flutter/wiki/Chat
Expand All @@ -62,29 +59,35 @@ you'll probably need to change the code in two places:
For example, say you want to change the following code in the
[Variables documentation](https://dart.dev/language/variables):

```
````
parlough marked this conversation as resolved.
Show resolved Hide resolved
<?code-excerpt "misc/lib/language_tour/variables.dart (var-decl)"?>
{% prettify dart tag=pre+code %}
```dart
var name = 'Bob';
{% endprettify %}
```
````

Besides editing
[/src/language/variables.md][]
[`/src/language/variables.md`][]
(which you can find by clicking the GitHub icon at the top right of the page),
you'll also need to edit the `var-decl` region of
[/examples/misc/lib/language_tour/variables.dart][].
[`/examples/misc/lib/language_tour/variables.dart`][].

If you create a PR but forget to edit the Dart file,
or if your changes don't analyze/test cleanly,
the [GitHub Actions][] CI build will fail.
Just update the PR, and GitHub Actions will run again.

If you followed the setup in the README,
you can instead run `dart run dart_site refresh-excerpts`
from the root directory of the repository to update the Markdown files.

[GitHub Actions]: https://docs.github.com/actions/learn-github-actions/understanding-github-actions
[/src/language/variables.md]: https://github.com/dart-lang/site-www/blob/main/src/language/variables.md
[/examples/misc/lib/language_tour/variables.dart]: https://github.com/dart-lang/site-www/blob/main/examples/misc/lib/language_tour/variables.dart
[`/src/language/variables.md`]: https://github.com/dart-lang/site-www/blob/main/src/language/variables.md
[`/examples/misc/lib/language_tour/variables.dart`]: https://github.com/dart-lang/site-www/blob/main/examples/misc/lib/language_tour/variables.dart

## A word about conduct

We pledge to maintain an open and welcoming environment.
For details, see our [code of conduct](https://dart.dev/community/code-of-conduct).
For details, see our [code of conduct][].

[code of conduct]: https://dart.dev/community/code-of-conduct
154 changes: 0 additions & 154 deletions Dockerfile

This file was deleted.

12 changes: 0 additions & 12 deletions Gemfile

This file was deleted.

Loading
Loading