Skip to content

Commit ff6b7f8

Browse files
ZachGoldbergResonance1584oredavids
authored
Docs Project Milestone 1 - Refactor Navigation (#2093)
* chore: start the nav refactor * chore: setup sidebars * more navigation skeleton * Lots more skeleton * Figure out the darn external link css * Lots more skeleton / nav fleshing out * more categories * be more truthful in the readme! * add boilerplate * more nav * more nav * lots of refactoring * Cleanup accountfactory nav * More categories * Docs Project Milestone 1 "trunk" branch (#2094) * initial commit on branch * Move devops and iac foundations pages * Move a few more files * Two more pages * Two more pages * Move FAQ * Another couple pages * Incorporate enable control tower docs * LZ and Account Vending Pages * Managing account migrates * Migrate lz logging * branding * Pipelines initial setup * Migrate architecture * Migrate module defaults docs (#2095) * chore: move network topology * Running apps * Devops foundations pages (#2100) * Migrate module defaults docs * Migrate cloud auth content (#2096) * Fix some broken links * Fix some broken links * Move patcher content to new structure (#2097) * Move patcher content to new structure * Remove old copy. Add patches and promotion workflows concept headers * Add developer portal docs (#2099) * chore: move dev portal under getting started * chor: remove redundant links in sidebar * remove unused file * fix: verb tense * Pipelines content migration to 2.0 (#2098) * Initial commit * Architecture migration * Port maintaining section * Move previous sections --------- Co-authored-by: Zach Goldberg <[email protected]> * port pipelines security controls * move audit logs * chore: add redirects too * Comebine machine users and repo access into setup guide for pipelines via machine users * Migrate branch protection * Add pipelines secrets docs * feat: add pipelines direct KB link * chore: bit more cleanup on drift detection docs * More page nav updates * Spider tool to ensure we're not breaking links through the refactor (#2104) * Simple script to generate a list of URLs in use on the docs site for testing * chore: make a dedicated folder * script to check for 404s w/docusaurus site * fix 2 broken redirects * Fix some broken links * more broken link fixes * more broken link fixes * chore: final round of broken link fixes * 2024 10 29 lewis/dev 587 migrate library pages (#2105) * Library overview * Move library content to new structure * Remove sidebar lable --------- Co-authored-by: Zach Goldberg <[email protected]> * fix library reference * tweaks to docs homepage * more docs homepage tweaks * Add redirects * remove now unneeded files * Work on fixing broken links without old files present * Lots more broken link fixes * More broken link fixes * Remaining broken links from the spider * Remove the docs-sources folder (#2103) * remove _docs-sources * Make docs-sourcer happy * Remove remaining hashes in 2.0 and the docs sources folder * README update * add a note about 1p secrets * Remove hidden/unused content, expose some useful hidden content, remove unused sidebars (#2108) * Make the homepage the docs index (#2116) * DEV-602 - Pipelines auth overview page (#2117) * docs: add intro paragraph for machine users * doc: new page outlining the two different auth mechanisms * typo * more dramatic pros for app * doc: make the recommendation for the app a bit stronger * DEV-609 - Add clarification on how to open a PR * DEV-608 - Update pipelines config as code docs/reference (#2115) * WIP: Pipelines config as code reference * lots more work on pipelines CaC reference * chore: remainder of dev-608 * Update docs/2.0/docs/pipelines/concepts/hcl-config-language.md Co-authored-by: Oreoluwa Agunbiade <[email protected]> * Update docs/2.0/reference/pipelines/configurations-as-code.md Co-authored-by: Lewis Christie <[email protected]> * Update docs/2.0/reference/pipelines/configurations-as-code.md Co-authored-by: Lewis Christie <[email protected]> * Update docs/2.0/docs/pipelines/installation/addingexistingrepo.md Co-authored-by: Oreoluwa Agunbiade <[email protected]> * Update docs/2.0/docs/pipelines/installation/addingexistingrepo.md Co-authored-by: Oreoluwa Agunbiade <[email protected]> * Update docs/2.0/docs/pipelines/installation/addingexistingrepo.md Co-authored-by: Oreoluwa Agunbiade <[email protected]> * Update docs/2.0/docs/pipelines/installation/addingexistingrepo.md Co-authored-by: Oreoluwa Agunbiade <[email protected]> * Update docs/2.0/docs/pipelines/installation/addingexistingrepo.md Co-authored-by: Oreoluwa Agunbiade <[email protected]> * Update docs/2.0/docs/pipelines/installation/addingexistingrepo.md Co-authored-by: Oreoluwa Agunbiade <[email protected]> * Update docs/2.0/docs/pipelines/installation/addingexistingrepo.md Co-authored-by: Oreoluwa Agunbiade <[email protected]> --------- Co-authored-by: Oreoluwa Agunbiade <[email protected]> Co-authored-by: Lewis Christie <[email protected]> * chore: explicitly mark patcher reference as under construction * remove inline ToC * Add Legacy Products section (#2118) * Add Legacy Products section * Add refarch sidebar * bump legacy products above utility links --------- Co-authored-by: Zach Goldberg <[email protected]> * DEV-601 Refactor pipelines config (#2114) * Refactorpipelines config * Refactor to use HCLListItem * Add account factory configuration * Update based on pipelines-actions usage * Add mise configuration * Add configs from pipelines binary * Move account factory specific config * Fix session-duration should be in pipelines configuration * chore: fix a link, minor copy tweak * add description for disable vpc inputs * default values for AF config * Use default component. Fix session-duration is not deprecated * more defaults * use better component mechanism * remove redundant sentence --------- Co-authored-by: Zach Goldberg <[email protected]> * Remove stay up to date test since _docs-sources has been removed * DEV-622 - Fix all broken links on homepage * Update docs-sourcer version * DEV-625 - Placeholders for all incomplete pages * augment the url list, don't overwrite it, to preserve historic urls * add some components to DF homepage * DEV-624 -- persistent checkboxes (#2121) * Basic check component with meh css * Basic example using the checkbox * DEV-623 Add next steps (#2123) * Add next steps page * Fix checkboxes. Add final step * work w/lewis to consolidate checklists * Delete docs/2.0/docs/overview/getting-started/next-steps.md --------- Co-authored-by: Zach Goldberg <[email protected]> Co-authored-by: Zach Goldberg <[email protected]> --------- Co-authored-by: Lewis Christie <[email protected]> * Add installing drift detection documentation (#2125) * Add installing drift detection documentation * Apply suggestions from code review Co-authored-by: Zach Goldberg <[email protected]> --------- Co-authored-by: Zach Goldberg <[email protected]> * Add Pipelines plan/apply/destroy tutorials (#2122) * Add plan/apply tutorial * Update instructions * Add pipelines destroy tutorial (#2124) * fix a broken link, make a pipelines install overview page --------- Co-authored-by: Zach Goldberg <[email protected]> * WIP - DEV-631 - Customizable Value component (#2126) * WIP: Customizable value component * now it actually works, needs styling * Move icon to css * Styling * missing close curly * WIP - make the custom things work inside a code block * fixes to make the build work * fix remaining issues with the build * fix the build / pin algolisearch * remove pin to fix warnings * minor css tweaks * Make replaceablevalue work in code block * Use the new feature, add a bit more CSS * chore: use session storage instead * DEV-632 - ensure titles work with customizable values * add content to README * DEV-633 - Ensure copy/paste gets the substitution as well --------- Co-authored-by: Lewis Christie <[email protected]> * missed another opportunity to use a var * use new fancy for destroy tutorial --------- Co-authored-by: Lewis Christie <[email protected]> Co-authored-by: Oreoluwa Agunbiade <[email protected]> Co-authored-by: Oreoluwa Agunbiade <[email protected]> * Replace a TODO with a slightly nicer message --------- Co-authored-by: Lewis Christie <[email protected]> Co-authored-by: Oreoluwa Agunbiade <[email protected]> Co-authored-by: Oreoluwa Agunbiade <[email protected]>
1 parent cb32637 commit ff6b7f8

File tree

670 files changed

+7409
-40681
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

670 files changed

+7409
-40681
lines changed

.mise.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[tools]
2+
yarn = "1.22.19"
3+

.yarnrc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
nodeLinker: node-modules

README.md

Lines changed: 21 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,21 @@
11
# Docs Site
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern
3+
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern
44
static website generator.
55

66
## Overview
77

88
### Docs Sourcer
99

10-
All of the content that we see on the docs site is rendered to the top level
11-
`docs/` folder by the
12-
[docs-sourcer](https://github.com/gruntwork-io/docs-sourcer). `docs-sourcer` is
13-
a process which can pull content from our GitHub repos as well as pre-process
14-
the MarkDown files which comprise the docs site's manually authored content (in
15-
`_docs-sources/`). At present, `docs-sourcer` isn't augmenting the content all
16-
that much, but in the future, the idea is that `docs-sourcer` will be able to
17-
pull in tagged content from other files, located in other GitHub repos, pull in
18-
images and auto-correct links. This will allow content creators to have more
19-
features when authoring content.
20-
21-
### Content creation
22-
23-
All manually created MarkDown source content lives in the `_docs-sources/`
24-
folder. The top level `docs/` folder contains the _generated_ output that
25-
results after the `docs-sourcer` processes the `_docs-sources/` directory.
26-
Grunts should **never edit any of the MarkDown files in the `docs/` folder
27-
directly**. We should always be editing the content in `_docs-sources/`.
10+
The vast majority of content in the `docs` folder is maintained by developers and not automation.
11+
There are, however, some types of docs that are maintained by a tool called `docs-sourcer`. You can
12+
identify those files by the `##DOCS-SOURCER-START` tag at the end of the file. In general
13+
this is content that is pulled from external sources, such as change logs, release notes and
14+
GitHub discussions.
15+
16+
Docs Sourcer is generally run in CI or via webhooks and doesn't have to be run locally. If, however, you do need
17+
to run it locally you will need access to various secrets. These secrets live in 1password under a secure note called
18+
"docs sourcer .env file".
2819

2920
## Installing dependencies
3021

@@ -39,23 +30,7 @@ yarn start
3930
```
4031

4132
This command starts a local development server and opens up a browser window.
42-
Most changes are reflected live without having to restart the server. This
43-
command also begins watching the `_docs-sources` directory for file changes. If
44-
you edit a file in `_docs-sources/` then the `docs-sourcer` will automatically
45-
re-run to regenerate the output files. Docusaurus will then hot-reload that
46-
content so that to the end user, they have "live reloading" while authoring.
47-
48-
### Committing changes
49-
50-
While authoring local content, you will exclusively be making your changes in
51-
the `_docs-sources/` folder. The `docs-sourcer` will then pre-process and
52-
generate output for you. To get your content _published_ you will need to commit
53-
**both** the "source" files in `_docs-sources/` as well as the generated content
54-
in the top level `docs/` folder.
55-
56-
Generated content should be up to date if you are previewing locally while
57-
editing but you may wish to manually regenerate the output (see section below)
58-
to ensure it is totally up to date.
33+
Most changes are reflected live without having to restart the server.
5934

6035
### Running a production build locally
6136

@@ -66,41 +41,21 @@ yarn build && yarn serve
6641
This will create and serve a production build. This can be used to verify the
6742
expected behaviors in a production environment and view the Google analytics.
6843

69-
### Manually generating docs output
44+
# Customizable Values
7045

71-
It's possible to manually regenerate output content from the sources in
72-
`_docs-sources/`:
73-
74-
```sh
75-
yarn regenerate:local
76-
```
46+
It's often useful to present the user with the ability to edit a variable inline to documentation. For example, you're about to present a block of code that references an S3 bucket name. Rather than put in a fixed placeholder like <BUCKET_NAME> which the user has to manually edit, you can use our CustomizableValue component. This component will render as a clickable text field which, when clicked, switches to an input. Any inputted characters will be auto-propegated to all other instances of the component that share the same ID. You can use this component both as a React component and inline to MDX code blocks. We have swizzled the CodeBlock components to make this possible.
7747

78-
This command can be run at any time, regardless of whether `yarn start` is
79-
currently running.
48+
Example usage:
8049

81-
### Generating sidebars for guides
82-
83-
We utilize explicit sidebar definitions for most of our docs content. Doing so enables authors to easily provide titles
84-
for all category labels, as well as define the relative ordering of pages in a maintainable way. Long-form docs with
85-
many sections receive a dedicated sidebar to provide a focused reading experience (e.g. /guides/build-it-yourself/\*).
86-
87-
A tool is provided to automatically generate sidebars for any new guide. To
88-
run it, specify the path to the directory you wish to create a sidebar for in
89-
either `_docs-sources/` or the output `docs/` path, relative to your current
90-
working directory.
91-
92-
```sh
93-
yarn sidebar docs/guides/build-it-yourself/my-new-guide/
50+
As a component:
51+
```js
52+
<CustomizableValue id="BUCKET_NAME">
9453
```
9554

96-
Once generated, you're free to adjust the names of each category, which only
97-
appear in the sidebar itself. You may also reorder any of the linked pages
98-
within each section, which will be reflected in the rendered output.
99-
100-
See the usage instructions with `yarn sidebar --help` to learn how to add a
101-
back button or specify an output file. The resulting file should be placed in
102-
the `sidebars/` directory. You'll also need to require this file in
103-
`sidebars.js`, and then re-run `yarn start` to see your changes.
55+
Using the \$\$ID\$\$ syntax inside a code block
56+
```md
57+
This is inside a code block, $$BUCKET_NAME$$
58+
```
10459

10560

10661
# Automated Pull Request Flows

_docs-sources/courses.mdx

Lines changed: 0 additions & 57 deletions
This file was deleted.

_docs-sources/developer-portal/link-github-id.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

_docs-sources/ecs-deploy-runner/how-it-works/index.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

0 commit comments

Comments
 (0)