-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add incomplete Starlight rewrite of docs site (#3760)
* 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
- Loading branch information
Showing
37 changed files
with
8,664 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
[codespell] | ||
skip = go.mod,go.sum,*.svg,Gemfile.lock | ||
skip = go.mod,go.sum,*.svg,Gemfile.lock,pnpm-lock.yaml | ||
ignore-words-list = dRan |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# build output | ||
dist/ | ||
# generated types | ||
.astro/ | ||
|
||
# dependencies | ||
node_modules/ | ||
|
||
# logs | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
|
||
|
||
# environment variables | ||
.env | ||
.env.production | ||
|
||
# macOS-specific files | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Terragrunt Docs: Starlight Rewrite | ||
|
||
This is the rewrite of the Terragrunt website using [Starlight](https://github.com/withastro/starlight), a documentation website framework for Astro. The goal is to provide a more user-friendly and accessible documentation for Terragrunt users. | ||
|
||
## Development | ||
|
||
To get started, install the requisite dependencies to run the project locally using [mise](https://mise.jdx.dev/): | ||
|
||
```bash | ||
mise install | ||
``` | ||
|
||
Afterwards, you'll want to install the dependencies for the project: | ||
|
||
```bash | ||
pnpm i | ||
``` | ||
|
||
You can now start the development server: | ||
|
||
```bash | ||
pnpm dev | ||
``` | ||
|
||
## WIP | ||
|
||
This is still a work in progress. Here are some of the tasks that need to be completed. For the list of tasks, see [TODO.md](TODO.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# TODO | ||
|
||
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** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
// @ts-check | ||
import { defineConfig } from 'astro/config'; | ||
import starlight from '@astrojs/starlight'; | ||
|
||
// https://astro.build/config | ||
export default defineConfig({ | ||
integrations: [ | ||
starlight({ | ||
title: 'Terragrunt', | ||
social: { | ||
github: 'https://github.com/gruntwork-io/terragrunt', | ||
discord: 'https://discord.gg/SPu4Degs5f', | ||
}, | ||
sidebar: [ | ||
{ | ||
label: 'Getting Started', | ||
autogenerate: { directory: 'getting-started' }, | ||
}, | ||
{ | ||
label: 'Features', | ||
autogenerate: { directory: 'features' }, | ||
}, | ||
{ | ||
label: 'Community', | ||
autogenerate: { directory: 'community' }, | ||
}, | ||
{ | ||
label: 'Reference', | ||
items: [ | ||
{ | ||
label: 'Configuration', slug: 'docs/reference/configuration', | ||
}, | ||
{ | ||
label: 'CLI', collapsed: true, items: [ | ||
{ label: 'Commands', autogenerate: { directory: 'reference/cli/commands', collapsed: true } }, | ||
], | ||
}, | ||
], | ||
}, | ||
{ | ||
label: 'Troubleshooting', | ||
autogenerate: { directory: 'troubleshooting' }, | ||
}, | ||
{ | ||
label: 'Migrate', | ||
autogenerate: { directory: 'migrate' }, | ||
}, | ||
], | ||
}), | ||
], | ||
redirects: { | ||
'/getting-started': '/quick-start', | ||
}, | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[tools] | ||
node = "23.7.0" | ||
pnpm = "9.15.4" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"name": "docs-starlight", | ||
"type": "module", | ||
"version": "0.0.1", | ||
"scripts": { | ||
"dev": "astro dev", | ||
"start": "astro dev", | ||
"build": "astro build", | ||
"preview": "astro preview", | ||
"astro": "astro" | ||
}, | ||
"dependencies": { | ||
"@astrojs/starlight": "^0.31.1", | ||
"astro": "^5.2.1", | ||
"sharp": "^0.32.5" | ||
} | ||
} |
Oops, something went wrong.