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

Edit pass for consistency #307

Merged
merged 5 commits into from
Oct 23, 2023
Merged

Edit pass for consistency #307

merged 5 commits into from
Oct 23, 2023

Conversation

bamurtaugh
Copy link
Member

@bamurtaugh bamurtaugh commented Oct 20, 2023

Complete the edit pass mentioned in devcontainers/spec#293 (comment)

Main changes:

  • Refer to the spec as "Development Container Specification"
    • All caps
    • Singular "Container" rather than "Containers" (plural feels awkward)
  • The term "dev container" shouldn't be capitalized on its own
  • Signify devcontainer.json is a file type through `
  • Features
    • Entire name is "Dev Container Features" (note the caps)
    • On their own, "Features" (note the caps)
  • Templates - same as Features
  • Refer to CLI as "Dev Container CLI" (note the caps)
  • Just use bolding for emphasis sprinkled throughout sections, rather than try to use it to always bold certain terms (this felt inconsistent and confusing)
  • Various other typos or formatting issues (i.e. the new CodeSandbox supporting tools section had some table issues)

I'll similarly review https://github.com/devcontainers/spec to provide a similar edit pass, following the guidance established here.

@bamurtaugh bamurtaugh self-assigned this Oct 20, 2023
@bamurtaugh bamurtaugh requested a review from a team as a code owner October 20, 2023 20:53
Copy link
Member

@samruddhikhandale samruddhikhandale left a comment

Choose a reason for hiding this comment

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

Than you for taking the time in contributing this PR 👏
It looks great, left some minor comments!

_implementors/features.md Outdated Show resolved Hide resolved
_implementors/spec.md Outdated Show resolved Hide resolved
_implementors/spec.md Show resolved Hide resolved
index.html Show resolved Hide resolved
overview.md Show resolved Hide resolved
supporting.md Show resolved Hide resolved
Co-authored-by: Samruddhi Khandale <skhandale@microsoft.com>
bamurtaugh and others added 3 commits October 20, 2023 14:23
@bamurtaugh
Copy link
Member Author

Made one more change and resolved some comments! @samruddhikhandale if you're able to give a quick re-review and approval, that'd be fantastic 🚀 Thank you!

Copy link
Member

@samruddhikhandale samruddhikhandale left a comment

Choose a reason for hiding this comment

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

@bamurtaugh bamurtaugh merged commit 5adf39c into gh-pages Oct 23, 2023
1 check passed
@bamurtaugh bamurtaugh deleted the bamurtaugh/edit-pass branch October 23, 2023 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants