Skip to content

Commit

Permalink
feat: Adding site-wide banner to collect feedback (#3852)
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

* feat: Adding broken link checking

* fix: Getting rid of `{{site.baseurl}}` everywhere

* feat: Create HCL directory for configuration

* wip: Fixing broken links

* wip: Fixing more broken links

* fix: Fixing bug from merge conflict

* fix: Fixing a bunch of broken links

* fix: Fixing English bugs

* fix: Use excludes instead of conditional build with link checks

* feat: Adding site-wide banner to collect feedback

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
  • Loading branch information
yhakbar and coderabbitai[bot] authored Feb 7, 2025
1 parent 8a2f17b commit 2f2d373
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs-starlight/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Here are some of the tasks that need to be completed:
- [ ] **Automate IaC Engine version lookup in docs**

## User Experience
- [ ] **User feedback collection**
- [x] **User feedback collection**
- [ ] **Broken link checking**
- [x] **Automate broken link checking**
- [ ] **Fix broken links**
Expand Down
13 changes: 12 additions & 1 deletion docs-starlight/src/content.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,18 @@ import { docsLoader } from '@astrojs/starlight/loaders';
import { docsSchema } from '@astrojs/starlight/schema';
import { glob } from 'astro/loaders';

const docs = defineCollection({ loader: docsLoader(), schema: docsSchema() });
const docs = defineCollection({
loader: docsLoader(), schema: docsSchema(
{
extend: z.object({
banner: z.object({ content: z.string() }).default({
content: "👷 The Terragrunt website redesign is Work In Progress! 👷</br>For a list of outstanding TODOs see <a href=\"https://github.com/gruntwork-io/terragrunt/blob/main/docs-starlight/TODO.md\">this</a>.</br>To give feedback, click <a href=\"https://forms.gle/MxfBQ5DebeAHA6oN6\">here</a>.",
}),
}),
},

)
});
const commands = defineCollection({
loader: glob({ pattern: "**/*.yml", base: "src/data/commands" }),
schema: z.object({
Expand Down
2 changes: 0 additions & 2 deletions docs-starlight/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,4 @@ hero:
- text: Reference
link: /docs/reference/cli/commands/opentofu-shortcuts
icon: open-book
banner:
content: 👷 The Terragrunt website redesign is Work In Progress! For a list of outstanding TODOs see [this](https://github.com/gruntwork-io/terragrunt/blob/main/docs-starlight/TODO.md). 👷
---

0 comments on commit 2f2d373

Please sign in to comment.