Skip to content

Commit

Permalink
feat: Content parity with prod docs (#3844)
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

---------

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 8077393 commit 33886d0
Show file tree
Hide file tree
Showing 48 changed files with 7,495 additions and 4,724 deletions.
2 changes: 1 addition & 1 deletion .codespellrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[codespell]
skip = go.mod,go.sum,*.svg,Gemfile.lock,pnpm-lock.yaml
skip = go.mod,go.sum,*.svg,Gemfile.lock,bun.lock
ignore-words-list = dRan
4 changes: 2 additions & 2 deletions docs-starlight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ mise install
Afterwards, you'll want to install the dependencies for the project:

```bash
pnpm i
bun i
```

You can now start the development server:

```bash
pnpm dev
bun dev
```

## WIP
Expand Down
24 changes: 17 additions & 7 deletions docs-starlight/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@ The Starlight rewrite of the Terragrunt website is a work in progress.

Here are some of the tasks that need to be completed:

- [ ] **Home Page**
- [ ] **Docker compose local dev setup**
- [ ] **Vercel deployment**
- [ ] **Content parity with current docs site**
- [ ] **User feedback collection**
- [ ] **Broken link checking**
- [ ] **Jekyll site banner indicating new site**
## Infrastructure
- [ ] **Docker compose local dev setup**
- [ ] **Vercel deployment**
- [x] **Vercel preview deployments**
- [ ] **Custom domain setup**

## Content
- [ ] **Content parity with current docs site**
- [ ] **Redesign reference to use cards**
- [ ] **Setup redirects for all old URLs**
- [ ] **Automate keeping versions updated**
- [ ] **Automate IaC Engine version lookup in docs**

## User Experience
- [ ] **User feedback collection**
- [ ] **Broken link checking**
- [ ] **Jekyll site banner indicating new site**
27 changes: 15 additions & 12 deletions docs-starlight/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -7,48 +7,51 @@ export default defineConfig({
integrations: [
starlight({
title: 'Terragrunt',
logo: {
src: '/src/assets/logo.svg',
},
social: {
github: 'https://github.com/gruntwork-io/terragrunt',
discord: 'https://discord.gg/SPu4Degs5f',
},
sidebar: [
{
label: 'Getting Started',
autogenerate: { directory: 'getting-started' },
autogenerate: { directory: '01-getting-started' },
},
{
label: 'Features',
autogenerate: { directory: 'features' },
autogenerate: { directory: '02-features', collapsed: true },
},
{
label: 'Community',
autogenerate: { directory: 'community' },
autogenerate: { directory: '03-community', collapsed: true },
},
{
label: 'Reference',
items: [
{
label: 'Configuration', slug: 'docs/reference/configuration',
},
{ label: 'Configuration', autogenerate: { directory: '04-reference/01-configuration', collapsed: true } },
{
label: 'CLI', collapsed: true, items: [
{ label: 'Commands', autogenerate: { directory: 'reference/cli/commands', collapsed: true } },
{ label: 'Commands', autogenerate: { directory: '04-reference/02-cli/commands', collapsed: true } },
],
},
{ label: 'Strict Controls', slug: 'docs/reference/strict-controls' },
{ label: 'Experiments', slug: 'docs/reference/experiments' },
{ label: 'Supported Versions', slug: 'docs/reference/supported-versions' },
{ label: 'Lock File Handling', slug: 'docs/reference/lock-file-handling' },
{ label: 'Terragrunt Cache', slug: 'docs/reference/terragrunt-cache' },
],
},
{
label: 'Troubleshooting',
autogenerate: { directory: 'troubleshooting' },
autogenerate: { directory: '05-troubleshooting', collapsed: true },
},
{
label: 'Migrate',
autogenerate: { directory: 'migrate' },
autogenerate: { directory: '06-migrate', collapsed: true },
},
],
}),
],
redirects: {
'/getting-started': '/quick-start',
},
});
1,018 changes: 1,018 additions & 0 deletions docs-starlight/bun.lock

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions docs-starlight/mise.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
[tools]
node = "23.7.0"
pnpm = "9.15.4"
bun = "1.2.2"
Loading

0 comments on commit 33886d0

Please sign in to comment.