Skip to content

Commit

Permalink
feat: Adding Docker Compose for local dev (#3847)
Browse files Browse the repository at this point in the history
* feat: Bare minimum starlight server as a starting point for prototyping

* feat: Upgrading starlight

* feat: Adding minimal starlight prototype

* feat: Switching to starlight Filetrees

* wip: WIP work on getting dynamic content

* chore: Pinning relevant versions in mise.toml

* fix: Fixing more filetrees

* fix: Working refactor

* fix: Adding dynamicity to astro

* fix: Fixing another Filetree

* fix: Fixing astro config

* feat: Done prototyping

* fix: Setting up routes to work like the legacy docs site

* fix: Adding a `TODO.md`

* fix: Fixing typo

* fix: Fixing favicon

* fix: Renaming all docs files so that they're lexically sorted

* fix: Adding logo

* feat: Working on getting features docs put together

* fix: Cleaning up Stacks feature docs

* feat: Adding includes docs

* feat: Small adjustment to trigger deployment

* fix: Add file names to all code fences

* fix: Adding file names to code fences

* feat: Adding scaffold

* feat: Adding extra arguments docs

* feat: Adding AWS authentication docs

* feat: Adding hooks docs

* feat: Updating hoomepage

* feat: Adding auto-init docs

* feat: Adding runtime control

* feat: Adding provider cache server docs

* feat: Adding engine docs

* fix: Fixing contribution docs

* fix: Fixing support docs

* feat: Adding license docs

* feat: Adding configuration overview

* feat: Adding configuration block docs

* feat: Adding attributes docs

* feat: Adding functions docs

* feat: Migrating CLI docs

* feat: Cleaning up old configuration docs

* fix: Moving over the rest of the docs

* feat: Adding strict controls and experiments docs

* chore: Bump pnpm

* feat: Adding remaining content

* fix: Bugs from merge

* fix: Downgrading node and pnpm

* fix: Adding package-lock.json

* fix: Moving to bun

* fix: Update README.md to point out that we're using bun

* fix: Fixing codespell ignore to ignore bun instead of pnpm

* Update docs-starlight/src/content/docs/02-features/09-hooks.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update docs-starlight/src/content/docs/02-features/12-provider-cache-server.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix: Updating banner

* fix: Better TODO

* fix: Fixing experiments docs

* fix: Cleaning up lock file handling docs

* fix: Fixing `auto-init` docs

* fix: More grammar updates

* fix: Fixing strict controls docs

* fix: Updating scaffold docs

* fix: Fixing functions docs

* fix: Moving engine docs to MDX so that we can add a script to fetch the latest version on request

* fix: Fixing runtime-control

* fix: Fixing hooks docs

* fix: Fixing aws-authentication docs

* fix: Fixing includes docs

* fix: Fixing state backend docs

* fix: Fixing configuration blocks and terragrunt cache

* fix: More typo fixes

* fix: More typo fixes

* fix: More English fixes

* fix: More English fixes

* fix: Don't try to use a link here

* fix: Fixing `TODO.md` formatting

* feat: Adding Docker Compose for local development

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
  • Loading branch information
yhakbar and coderabbitai[bot] authored Feb 6, 2025
1 parent 33886d0 commit 70b8959
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
28 changes: 28 additions & 0 deletions docs-starlight/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# FROM oven/bun:1.2.2
#
# WORKDIR /app
# COPY package.json bun.lock ./
#
# RUN bun install
#
# COPY . .
#
# EXPOSE 4321
#
# CMD ["bun", "run", "dev"]

# There's a bug that prevents us from using bun for this:
# https://github.com/oven-sh/bun/issues/17022

FROM node:22

WORKDIR /app
COPY package.json ./

RUN npm install

COPY . .

EXPOSE 4321

CMD ["npm", "run", "dev", "--", "--host", "0.0.0.0"]
4 changes: 3 additions & 1 deletion docs-starlight/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ The Starlight rewrite of the Terragrunt website is a work in progress.
Here are some of the tasks that need to be completed:

## Infrastructure
- [ ] **Docker compose local dev setup**
- [x] **Docker compose local dev setup**
- [ ] **Vercel deployment**
- [x] **Vercel preview deployments**
- [ ] **Custom domain setup**

## Content
- [ ] **Content parity with current docs site**
- [x] **Parity for all docs except CLI reference**
- [ ] **Parity for CLI reference**
- [ ] **Redesign reference to use cards**
- [ ] **Setup redirects for all old URLs**
- [ ] **Automate keeping versions updated**
Expand Down
13 changes: 13 additions & 0 deletions docs-starlight/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
services:
web:
build: .
volumes:
# Bind mount the working dir for live reload
- .:/app
# Avoid mounting node_modules from host
- /app/node_modules
ports:
# Astro dev server port
- "4321:4321"
environment:
- NODE_ENV=development

0 comments on commit 70b8959

Please sign in to comment.