Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Daverandolph boundary doc days #4561

Merged
merged 19 commits into from
Apr 11, 2024
Merged

Daverandolph boundary doc days #4561

merged 19 commits into from
Apr 11, 2024

Conversation

hashidave
Copy link
Collaborator

Created a new document called "Terraform Patterns" and updated the index.
This folds in some of Carlos V's session recording code as well.

Copy link
Contributor

@AdamBouhmad AdamBouhmad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic job!! Extremely thorough and frankly, something that our customers have needed for quite some time for getting started w/Boundary using terraform for config mgmt

@AdamBouhmad AdamBouhmad self-requested a review March 21, 2024 21:55
@Dan-Heath
Copy link
Contributor

Dan-Heath commented Apr 10, 2024

This is an excellent contribution to the docs, thank you! It reads well and is easy to understand. These patterns will be really helpful to our users.

I think the new topic could be broken into smaller pieces to make it more manageable. Breaking out the patterns by sub-heading would allow us to put them all on the TOC and create metadata at the individual topic level. That should make this content easier for our users to find either in the help system or via external search (i.e. Google). We could add some pre-requisite and next steps sections to guide users through the topics to the most likely workflows.

I pushed a commit that shows what I am thinking in terms of the restructure and new sections. I commented out the info from the original topic, so we can roll it back if the content doesn't make sense like this.

View the proposed structure in the preview deployment

Copy link
Collaborator

@stellarsquall stellarsquall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love the new format as a book instead of a single page. I think it's easier to parse and find what you need. Thanks!

@Dan-Heath Dan-Heath added the backport/website Backport changes to `stable-website` and the latest release-branch label Apr 11, 2024
Copy link
Contributor

@Dan-Heath Dan-Heath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work on this @hashidave , @dgreeninger , @AdamBouhmad , @stellarsquall ! Thank you for taking the time to improve our docs ❤️

@Dan-Heath Dan-Heath self-assigned this Apr 11, 2024
@Dan-Heath Dan-Heath merged commit f2c2a77 into main Apr 11, 2024
7 checks passed
@Dan-Heath Dan-Heath deleted the daverandolph-boundary-doc-days branch April 11, 2024 14:16
Dan-Heath added a commit that referenced this pull request Apr 11, 2024
* Added using-terraform.mdx to the Install Boundary section

* Initial revision

* formatting on the list and adding in some links to the provider

* Renamed file

* Added assumptions.

* Updated index.

* Fixed some typos

* Folded in Carlos's session recording code

* small changes

* fixes headers

* fixes internal developer links

* style guide and formatting enhancements

* updates Initialize Boundary link

* docs: Updates for style/standards

* docs: Break topic into smaller pieces

* docs: Clean up commented text, rename index file

* docs: Trigger a new Vercel build

---------

Co-authored-by: Daniel Greeninger <[email protected]>
Co-authored-by: Adam Bouhmad <[email protected]>
Co-authored-by: Robin Beck <[email protected]>
Co-authored-by: Dan Heath <[email protected]>
Dan-Heath added a commit that referenced this pull request Apr 11, 2024
* Added using-terraform.mdx to the Install Boundary section

* Initial revision

* formatting on the list and adding in some links to the provider

* Renamed file

* Added assumptions.

* Updated index.

* Fixed some typos

* Folded in Carlos's session recording code

* small changes

* fixes headers

* fixes internal developer links

* style guide and formatting enhancements

* updates Initialize Boundary link

* docs: Updates for style/standards

* docs: Break topic into smaller pieces

* docs: Clean up commented text, rename index file

* docs: Trigger a new Vercel build

---------

Co-authored-by: HashiDaveR <[email protected]>
Co-authored-by: Daniel Greeninger <[email protected]>
Co-authored-by: Adam Bouhmad <[email protected]>
Co-authored-by: Robin Beck <[email protected]>
Dan-Heath added a commit that referenced this pull request Apr 11, 2024
* Added using-terraform.mdx to the Install Boundary section

* Initial revision

* formatting on the list and adding in some links to the provider

* Renamed file

* Added assumptions.

* Updated index.

* Fixed some typos

* Folded in Carlos's session recording code

* small changes

* fixes headers

* fixes internal developer links

* style guide and formatting enhancements

* updates Initialize Boundary link

* docs: Updates for style/standards

* docs: Break topic into smaller pieces

* docs: Clean up commented text, rename index file

* docs: Trigger a new Vercel build

---------

Co-authored-by: Daniel Greeninger <[email protected]>
Co-authored-by: Adam Bouhmad <[email protected]>
Co-authored-by: Robin Beck <[email protected]>
Co-authored-by: Dan Heath <[email protected]>
Dan-Heath added a commit that referenced this pull request Apr 11, 2024
* Added using-terraform.mdx to the Install Boundary section

* Initial revision

* formatting on the list and adding in some links to the provider

* Renamed file

* Added assumptions.

* Updated index.

* Fixed some typos

* Folded in Carlos's session recording code

* small changes

* fixes headers

* fixes internal developer links

* style guide and formatting enhancements

* updates Initialize Boundary link

* docs: Updates for style/standards

* docs: Break topic into smaller pieces

* docs: Clean up commented text, rename index file

* docs: Trigger a new Vercel build

---------

Co-authored-by: HashiDaveR <[email protected]>
Co-authored-by: Daniel Greeninger <[email protected]>
Co-authored-by: Adam Bouhmad <[email protected]>
Co-authored-by: Robin Beck <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/website Backport changes to `stable-website` and the latest release-branch event/boundary-docs-day Boundary Docs Day event website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants