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.

Sign up for GitHub

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

Jump to bottom

docs: content debt #430

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: content debt #430

wants to merge 2 commits into from
+3,123 −2,792

Conversation

tenthirtyam
Copy link
Collaborator

@tenthirtyam tenthirtyam commented May 10, 2024 •
edited

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 Improvements or additions to 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 nywilken and lbajolet-hashicorp 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 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
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/config_location.go Outdated Show resolved Hide resolved
builder/vsphere/common/step_hardware.go Show resolved Hide resolved
builder/vsphere/common/step_import_to_content_library.go Outdated Show resolved Hide resolved
builder/vsphere/common/step_import_to_content_library.go Outdated Show resolved Hide resolved
builder/vsphere/common/step_import_to_content_library.go Outdated Show resolved Hide resolved
builder/vsphere/common/storage_config.go Outdated
// }
//
// ```

Copy link
Contributor

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
Collaborator Author

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
Contributor

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?

builder/vsphere/common/storage_config.go Outdated Show resolved Hide resolved
builder/vsphere/iso/step_create.go Show resolved Hide resolved
builder/vsphere/iso/step_create.go Outdated Show resolved Hide resolved
builder/vsphere/iso/step_create.go Outdated Show resolved Hide resolved
@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
Open
@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
Collaborator Author

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.

lbajolet-hashicorp
lbajolet-hashicorp approved these changes May 24, 2024
View reviewed changes
Copy link
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
Contributor

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?

builder/vsphere/iso/step_create.go Show resolved Hide resolved
docs/builders/vsphere-clone.mdx Outdated Show resolved Hide resolved
@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 <[email protected]>
@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
Collaborator Author

Comments resolved in ffbb6ea. 🌮

@tenthirtyam
docs: technical debt
c398a19 
- 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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nywilken nywilken Awaiting requested review from nywilken

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

Assignees

@tenthirtyam tenthirtyam

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v1.3.1
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@tenthirtyam @lbajolet-hashicorp