Refactor docs to live on their own (#6454)

Author: btobin

.firebaserc

@@ -1,6 +1,6 @@
 {
   "projects": {
-    "default": "flutter-dev-230821",
+    "default": "flutter-docs-prod",
     "flutter-dev": "flutter-dev-230821",
     "flutter-io": "sweltering-fire-2088",
     "staging-1": "flutter-io-staging-1",

.github/ISSUE_TEMPLATE/1_page_issue.yml

@@ -9,7 +9,7 @@ body:
     id: page-url
     attributes:
       label: Page URL
-      placeholder: "Example: https://flutter.dev/docs"
+      placeholder: "Example: https://docs.flutter.dev"
     validations:
       required: true
   - type: input

.github/workflows/build.yml

@@ -12,12 +12,13 @@ on:
 
 env:
   NODE_ENV: production
-  NODE_VERSION: 15
+  NODE_VERSION: 17
 
 jobs:
 
   test:
     runs-on: ubuntu-latest
+    if: github.repository == 'flutter/website'
     strategy:
       fail-fast: false
       matrix:

.github/workflows/link-validate.yml

@@ -1,4 +1,4 @@
-name: HTML link references validate
+name: Validate link references in built HTML
 
 on:
   push:
@@ -8,27 +8,18 @@ on:
     branches:
       - main
 
-env:
-  NODE_ENV: production
-  NODE_VERSION: 15
-
 jobs:
   check_link_references:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
         with:
           submodules: "recursive"
-      - name: Install Node
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ env.NODE_VERSION }}
       - name: Build
         run: make build
         env:
           DISABLE_TESTS: 1
       - uses: actions/setup-python@v2
         with:
           python-version: "3.x"
-      - run: pip install PyYAML
       - run: python tool/check_link_references.py

.gitignore

@@ -19,3 +19,4 @@ node_modules
 example.g
 pubspec.lock
 tmp/
+_config_stage.yml

Dockerfile

@@ -4,7 +4,7 @@ FROM ruby:${RUBY_VERSION}-buster as dev
 
 ENV TZ=US/Pacific
 
-ARG NODE_VERSION=15
+ARG NODE_VERSION=17
 ENV NODE_VERSION=$NODE_VERSION
 
 RUN curl -sL https://deb.nodesource.com/setup_${NODE_VERSION}.x -o node_setup.sh && \
@@ -56,7 +56,7 @@ RUN if test -n "$FLUTTER_BRANCH" -a "$FLUTTER_BRANCH" != "stable" ; then \
     fi
 
 # Set up Flutter
-RUN flutter doctor --suppress-analytics --quiet
+RUN flutter doctor
 RUN flutter --version
 RUN dart pub get
 
@@ -65,9 +65,6 @@ EXPOSE 4002
 
 
 # -- Test target
-# NOTE that instead of have a script that tests all targets,
-# we could build a new docker container for each test and 
-# start clean
 FROM dev as test
 ARG DISABLE_TESTS
 ENV DISABLE_TESTS=$DISABLE_TESTS
@@ -90,16 +87,12 @@ RUN cd flutter && \
       git fetch origin stable && \
       git checkout stable && \
       git pull
-
 RUN flutter doctor
-
-# NOTE this is a bit sneaky and we could be more clear about it 
-# by having an actual production template for robots.txt rather 
-# than changing the contents of the file at build/test time. 
-# This is similarly seen in tool/check-links.sh
 RUN echo "User-agent: *" > src/robots.txt && echo "Allow: /" >> src/robots.txt
 
-RUN bundle exec jekyll build --config _config.yml
+ARG BUILD_CONFIGS=_config.yml
+ENV BUILD_CONFIGS=$BUILD_CONFIGS
+RUN bundle exec jekyll build --config $BUILD_CONFIGS
 
 
 # -- Deploy target
@@ -109,14 +102,14 @@ ARG FIREBASE_TOKEN
 ENV FIREBASE_TOKEN=$FIREBASE_TOKEN
 ARG FIREBASE_ALIAS=default
 ENV FIREBASE_ALIAS=${FIREBASE_ALIAS:-default}
-ARG COMMIT=$(git rev-parse --short HEAD)
-ENV COMMIT=$COMMIT
+ARG BUILD_COMMIT=$(git rev-parse --short HEAD)
+ENV BUILD_COMMIT=$COMMIT
 
 RUN firebase use $FIREBASE_ALIAS
-RUN firebase deploy -m $COMMIT \
+RUN firebase deploy -m $BUILD_COMMIT \
       --only hosting \
       --non-interactive \
       --token $FIREBASE_TOKEN \
       --project $FIREBASE_ALIAS \
       --debug \
-	--json
+      --json

Makefile

@@ -10,6 +10,8 @@ all: gen-env up down debug shell setup serve switch-channel test-channel \
 .DEFAULT_GOAL := up
 .PHONY: all
 
+FIREBASE_ALIAS ?= default
+
 
 # =================== Development Commands ==================
 
@@ -68,7 +70,7 @@ serve:
 
 # Test hosting locally with FB emulator
 emulate:
-	firebase emulators:start --only hosting
+	firebase emulators:start --only hosting --project ${FIREBASE_ALIAS}
 
 
 # =================== Testing locally from host ==================
@@ -133,7 +135,7 @@ check-links:
 
 FLUTTER_BRANCH ?= stable
 TEST_TARGET_CHANNEL ?= stable
-FIREBASE_ALIAS ?= default
+BUILD_CONFIGS ?= _config.yml
 BUILD_COMMIT := $(shell git rev-parse --short HEAD)
 BUILD_TAG = fltbuild
 BUILD_NAME = tmpbuild
@@ -164,12 +166,13 @@ debug-test:
 # those will be run on the Github action.
 # Usage: `DISABLE_TESTS=1 make build-image`
 build-image:
-	docker build --no-cache --rm --target builder \
+	docker build --rm --target builder \
 		--build-arg FIREBASE_ALIAS=${FIREBASE_ALIAS} \
 		--build-arg FIREBASE_TOKEN=${FIREBASE_TOKEN} \
 		--build-arg FLUTTER_BRANCH=${FLUTTER_BRANCH} \
 		--build-arg DISABLE_TESTS=${DISABLE_TESTS} \
-		--build-arg COMMIT=${BUILD_COMMIT} \
+		--build-arg BUILD_COMMIT=${BUILD_COMMIT} \
+		--build-arg BUILD_CONFIGS=${BUILD_CONFIGS} \
 		--build-arg RUBY_VERSION=${RUBY_VERSION} \
 		--build-arg NODE_VERSION=${NODE_VERSION} -t ${BUILD_TAG}:${BUILD_COMMIT} .
 
@@ -205,13 +208,16 @@ else
 		--json
 endif
 
-STAGE_NAME ?= stage
+
 # All in one command to stage your build to a Firebase 
 # channel on your currently selected project
 # Usage: `make stage STAGE_NAME=foo`
+STAGE_NAME ?= docs
 stage:
-	make build
-	firebase hosting:channel:deploy ${STAGE_NAME}
+	make build BUILD_CONFIGS=_config.yml,_config_stage.yml
+	firebase hosting:channel:deploy ${STAGE_NAME} \
+		--project ${FIREBASE_ALIAS} \
+		--token ${FIREBASE_TOKEN}
 
 
 

README.md

@@ -1,4 +1,4 @@
-[![Flutter logo]](https://flutter.dev)
+[![Flutter logo]](https://docs.flutter.dev)
 # [Flutter][] website 
 
 [![Build Status][]][Repo on GitHub Actions]
@@ -298,7 +298,7 @@ Also check out the site-shared [wiki](https://github.com/dart-lang/site-shared/w
 [DartPad]: https://dartpad.dev
 [`firebase use` command]: https://firebase.googleblog.com/2016/07/deploy-to-multiple-environments-with.html
 [forking]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
-[Flutter install]: https://flutter.dev/docs/get-started/install
+[Flutter install]: https://docs.flutter.dev/get-started/install
 [Flutter logo]: https://github.com/dart-lang/site-shared/blob/master/src/_assets/image/flutter/icon/64.png?raw=1
 [Firebase]: https://firebase.google.com/
 [Google Developer Documentation Style Guidelines]: https://developers.google.com/style

_config.yml

@@ -1,23 +1,19 @@
 title: Flutter
-
-url: https://flutter.dev
-
+url: https://docs.flutter.dev
+main-url: https://flutter.dev
 email: flutter-dev@googlegroups.com
 
 google_analytics_id: UA-67589403-1
 google_site_verification: HFqxhSbf9YA_0rBglNLzDiWnrHiK_w4cqDh2YD2GEY4
 google_tag_manager_id: GTM-ND4LWWZ
 default_share_image: /assets/images/flutter-logo-sharing.png
-  
 
-branch: main
 
 github_username: flutter
+branch: main
 repo:
   organization: https://github.com/flutter
-
   this: https://github.com/flutter/website
-
   flutter: https://github.com/flutter/flutter
   samples: https://github.com/flutter/samples
   plugins: https://github.com/flutter/plugins
@@ -92,27 +88,27 @@ defaults:
       show_banner: true
       show_footer: true
   - scope:
-      path: 'docs'
+      path: ''
     values:
       toc: true
   - scope:
-      path: 'docs/cookbook'
+      path: 'cookbook'
     values:
       show_breadcrumbs: true
   - scope:
-      path: 'docs/development'
+      path: 'development'
     values:
       show_breadcrumbs: true
   - scope:
-      path: 'docs/development/ui/widgets'
+      path: 'development/ui/widgets'
     values:
       toc: false
   - scope:
-      path: 'docs/get-started'
+      path: 'get-started'
     values:
       show_breadcrumbs: true
   - scope:
-      path: 'docs/get-started/flutter-for'
+      path: 'get-started/flutter-for'
     values:
       show_breadcrumbs: false
 

docker-compose.yml

@@ -11,9 +11,13 @@ services:
     environment:
       - NODE_ENV=development
       - JEKYLL_ENV=development
+      - DISABLE_TESTS=$DISABLE_TESTS
+      - FIREBASE_ALIAS=$FIREBASE_ALIAS
+      - FIREBASE_TOKEN=$FIREBASE_TOKEN
     ports:
       - "4002:4002"
       - "35729:35729"
+      - "5500:5500"
     volumes:
       - ./:/app
       - site_bundle:/usr/local/bundle