The Dart language site (dart.dev)

The https://dart.dev site, built with Jekyll and hosted on Firebase.

We welcome contributions, and we're first-timer friendly!

For simple changes (such as to CSS and text), you probably don't need to build this site.
Often you can make changes using the GitHub UI.

If you want or need to build, follow the steps below.

Help us improve these instructions!
If you have any problems getting set up to build or performing the actual build,
please edit this README
or file an issue
(or both).

Before you build this site

1. Get the prerequisites

Install the following tools if you don't have them already.

• bash, the Bourne shell. These instructions assume you're using bash -- setup might not work if you use another shell.
• nvm, the Node Version Manager.
• rvm, the Ruby Version Manager.
• Dart

IMPORTANT: Follow the installation instructions for each of the tools
carefully. In particular, configure your shell/environment so
that the tools are available in every terminal/command window you create.

2. Clone this repo and its submodule

NOTE: This repo has a git submodule, which affects how you clone it.

To clone this repo (site-www), follow the instructions given in the
GitHub help on Cloning a repository, and choose one of the following
submodule-cloning techniques:

• Clone this repo and its submodule at the same, use the
  --recurse-submodules option:
  git clone --recurse-submodules https://github.com/dart-lang/site-www.git
• If you've already cloned this repo without its submodule, then run
  this command from the repo root:
  git submodule update --init --remote

IMPORTANT:
Whenever you update your repo, update the submodule as well:
git pull; git submodule update --init --remote

3. Run installation scripts

NOTE: It is safe to (re-)run all of the commands and scripts given below even
if you already have the required packages installed.

Open a bash terminal/command window and execute the following commands:

1. cd <path-to-this-repo>   # change to
   root of this repo
2. source ./tool/env-set.sh   #
   initialize environment variables; install/use required Node & Ruby version
3. ./tool/before-install.sh   #
   install core set of required tools
4. ./tool/install.sh   #
   install everything else needed to build this site

IMPORTANT:

• Any time you create a new terminal/command window to work on
  this repo, repeat steps 1 and 2 above.
• If you upgrade Dart then rerun all of the steps above.

Building this site

Once everything is installed, you need to do a full site build at least once:

• jekyll build   # full site build

The generated site is placed in the _site folder. To serve this folder use:

• npx superstatic --port 4000

Or, if you aren't testing redirects, use this command (which has the bonus of
autorefreshing your browser after edits):

• jekyll serve --livereload

To view the generated site open localhost:4000 in a browser.

You can build, serve, and have a watcher for changes by running the following command:

• ./tool/serve.sh

Pre-push checks

If you've made changes to this site's documentation and committed locally, then
run the following command before pushing your work:

./tool/pre-push.sh

If the script reports errors or warnings, then address the issues and rerun the
script. Otherwise, you can push your changes.

Site checks

Checking example code

If you've made changes to the example code run the following commands:

• ./tool/dartfmt.sh
• ./tool/refresh-code-excerpts.sh
• ./tool/analyze-and-test-examples.sh --quick

If the last command reports failed tests and you'd like to know which
test failed, then rerun the command without the -q flag.

Checking the site's HTML

First, build the site and launch the server:

jekyll build && npx superstatic --port 4000

Next, to check for broken links,
run this from the top of the repo:

./tool/shared/check-links.sh

To also check external URLs (which is much slower), run the linkcheck command
with the --external (or -e, for short) option.

With this tool you can check any URL by simply specifying it as a parameter:

pub global activate linkcheck
linkcheck https://dart.dev

To check for valid HTML, good images, and broken links (though not as well
as linkcheck.dart), run this from the top of the repo:
NOTE: As of April 16, 2019, this doesn't work. See
issue #1461.

./deploy/html_proof.rb

To find old links (from the site version before this one) that are broken,
use these commands:

./tool/serve.sh &
linkcheck -i deploy/urls/old_site_urls.txt

Staging the site

First, save your changes.
For example, from the top directory:

git commit src

Create a pull request by pushing your branch to GitHub.

git push origin <branchname>

Navigate to the Firebase console,
console.firebase.google.com.

If you don't already have a project to stage to,
create it:

1. Select Create New Project.
2. Enter a project name in the dialog, such as staging-1.
3. Click Create Project. This takes you to the
   page for your new project.

Note: To keep the number of projects under control,
we reuse them. Our naming convention is
<first initial><last initial>-dart-dev-<number>, for example,
sz-dart-dev-1 and kw-dart-dev-1.

Return to the Firebase console.
You should now see your project in the list.
Copy the name of your project (e.g. sz-dart-dev-2) to your clipboard.

On the command line, from the top of GitHub repo, edit the .firebaserc file.

Change dart-dev to the name of your project. For example:

{
  "projects": {
    "default": "sz-dart-dev-2"
  }
}

Build the docs, to get the latest changes
and set the new project name:

jekyll build

Then deploy the docs:

./tool/shared/deploy.sh --robots ok default

You can now navigate to the staged version at
https://<your-instance>.firebaseapp.com -— for example,
https://sz-dart-dev-2.firebaseapp.com.

Important: Don't commit the .firebaserc file containing the name of your staged version.

Navigate to the PR on GitHub and update it with the location of the staged version,
the names of your reviewers, and so on.

Before making any more changes, stash .firebaserc:

git stash

You can later retrieve the stashed file, if you need to stage again,
using git stash pop.

Troubleshooting the build

See the Troubleshooting wiki page.