Skip to content

docs: content debt#430

Merged
lbajolet-hashicorp merged 2 commits intomainfrom
docs/technical-debt
May 28, 2024
Merged

docs: content debt#430
lbajolet-hashicorp merged 2 commits intomainfrom
docs/technical-debt

Conversation

@tenthirtyam
Copy link
Copy Markdown
Collaborator

@tenthirtyam tenthirtyam commented May 10, 2024 •
edited
Loading

Summary

  • General cleanup of the documentation.
  • Standardize heading for Required and Optional.
  • Standardize headings for HCL and JSON.
  • Standardize leading with HCL examples.
  • Format for cleanliness.
  • Moves builder/vsphere/examples/ to examples/.

@tenthirtyam tenthirtyam added the documentation Documentation label May 10, 2024
@tenthirtyam tenthirtyam added this to the On Deck milestone May 10, 2024
@tenthirtyam tenthirtyam self-assigned this May 10, 2024
@tenthirtyam tenthirtyam force-pushed the docs/technical-debt branch 5 times, most recently from 650b0c2 to fe53cbf Compare May 13, 2024 15:32
@tenthirtyam tenthirtyam requested review from lbajolet-hashicorp and nywilken and removed request for nywilken May 13, 2024 15:32
@tenthirtyam tenthirtyam marked this pull request as ready for review May 13, 2024 15:32
@tenthirtyam tenthirtyam requested a review from a team as a code owner May 13, 2024 15:32
@tenthirtyam tenthirtyam requested a review from nywilken May 13, 2024 15:33
@tenthirtyam tenthirtyam marked this pull request as draft May 13, 2024 15:34
@tenthirtyam tenthirtyam force-pushed the docs/technical-debt branch from fe53cbf to 145b530 Compare May 13, 2024 15:40
@tenthirtyam tenthirtyam marked this pull request as ready for review May 13, 2024 15:41
@tenthirtyam tenthirtyam changed the title docs: technical debt docs: content debt May 13, 2024
@tenthirtyam tenthirtyam modified the milestones: On Deck, v1.3.1 May 13, 2024
lbajolet-hashicorp
lbajolet-hashicorp reviewed May 13, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@lbajolet-hashicorp lbajolet-hashicorp left a comment

Choose a reason for hiding this comment

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

Overall LGTM! Left a few nits/suggestions, will take another look when you've addressed those @tenthirtyam

builder/vsphere/common/storage_config.go Outdated
// }
//
// ```

Copy link
Copy Markdown
Contributor

@lbajolet-hashicorp lbajolet-hashicorp May 13, 2024

Choose a reason for hiding this comment

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

Superfluous empty line? I may be wrong but I suspect this will unlink the above documentation from the type, is that expected?

Copy link
Copy Markdown
Collaborator Author

@tenthirtyam tenthirtyam May 13, 2024

Choose a reason for hiding this comment

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

Addressed in ccab453.

Copy link
Copy Markdown
Contributor

@lbajolet-hashicorp lbajolet-hashicorp May 24, 2024

Choose a reason for hiding this comment

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

Looks like this empty line is still there, could you confirm this was intended?

@tenthirtyam tenthirtyam force-pushed the docs/technical-debt branch 3 times, most recently from 42c68d4 to ef9173a Compare May 13, 2024 20:59
@tenthirtyam tenthirtyam mentioned this pull request May 16, 2024
Merged
@tenthirtyam tenthirtyam force-pushed the docs/technical-debt branch 2 times, most recently from fd96970 to 9672af1 Compare May 17, 2024 03:04
@tenthirtyam
Copy link
Copy Markdown
Collaborator Author

tenthirtyam commented May 17, 2024

Overall LGTM! Left a few nits/suggestions, will take another look when you've addressed those @tenthirtyam

I pushed a small update to move builder/vsphere/examples/ to examples/ and organize them there. Plan to update each of these with additional content for starters.

@tenthirtyam tenthirtyam force-pushed the docs/technical-debt branch from 9672af1 to 6c1c14d Compare May 17, 2024 04:10
lbajolet-hashicorp
lbajolet-hashicorp approved these changes May 24, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@lbajolet-hashicorp lbajolet-hashicorp left a comment

Choose a reason for hiding this comment

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

Left a last few comments, but overall LGTM!

Pre-approving

builder/vsphere/common/storage_config.go Outdated
// }
//
// ```

Copy link
Copy Markdown
Contributor

@lbajolet-hashicorp lbajolet-hashicorp May 24, 2024

Choose a reason for hiding this comment

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

Looks like this empty line is still there, could you confirm this was intended?

@tenthirtyam
docs: technical debt
3cca8d6 
- General cleanup of the documentation.
- Standardize heading for Required and Optional.
- Standardize headings for HCL and JSON.
- Standardize leading with HCL examples.
- Format for cleanliness.

Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
@tenthirtyam tenthirtyam force-pushed the docs/technical-debt branch 2 times, most recently from 70a5f5d to ffbb6ea Compare May 24, 2024 20:13
@tenthirtyam
Copy link
Copy Markdown
Collaborator Author

tenthirtyam commented May 24, 2024

Comments resolved in ffbb6ea. 🌮

@tenthirtyam tenthirtyam force-pushed the docs/technical-debt branch 2 times, most recently from c398a19 to 8b3bb05 Compare May 28, 2024 13:02
@tenthirtyam
docs: technical debt
d506a19 
- General cleanup of the documentation.
- Standardize heading for Required and Optional.
- Standardize headings for HCL and JSON.
- Standardize leading with HCL examples.
- Format for cleanliness.
- Moves `builder/vsphere/examples/` to `examples/`.

Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
@tenthirtyam tenthirtyam force-pushed the docs/technical-debt branch from 8b3bb05 to d506a19 Compare May 28, 2024 13:11
@lbajolet-hashicorp
Copy link
Copy Markdown
Contributor

lbajolet-hashicorp commented May 28, 2024

LGTM, thanks for the rerolls!

Merging now

@lbajolet-hashicorp lbajolet-hashicorp merged commit 8951b15 into main May 28, 2024
@lbajolet-hashicorp lbajolet-hashicorp deleted the docs/technical-debt branch May 28, 2024 18:23
@vmware vmware locked as resolved and limited conversation to collaborators Jun 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@nywilken nywilken Awaiting requested review from nywilken

@lbajolet-hashicorp lbajolet-hashicorp Awaiting requested review from lbajolet-hashicorp

Assignees

@tenthirtyam tenthirtyam

Labels

documentation Documentation

Projects

None yet

Milestone

v1.4.0

Development

Successfully merging this pull request may close these issues.

2 participants

@tenthirtyam @lbajolet-hashicorp