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

(#2) Adds Initial Examples #3

Merged
merged 2 commits into from
Oct 25, 2023
Merged

(#2) Adds Initial Examples #3

merged 2 commits into from
Oct 25, 2023

Conversation

JPRuskin
Copy link
Member

@JPRuskin JPRuskin commented Oct 4, 2023

Description Of Changes

Adds an initial readme and some example deployments to the repository.

Motivation and Context

These examples can be displayed and linked to on our docs page, referred to by teammembers, or contributed to by community members.

Testing

  • Tested importing several of the deployments to a recent install of CCM

Operating Systems Testing

N/A

Change Types Made

  • [ ] Bug fix (non-breaking change).
  • Feature / Enhancement (non-breaking change).
  • [ ] Breaking change (fix or feature that could cause existing functionality to change).
  • Documentation changes.
  • [ ] PowerShell code changes.

Change Checklist

  • Requires a change to the documentation.
  • Documentation has been updated.
    This needs to be merged before the documentation can link to it.
  • [ ] Tests to cover my changes, have been added.
  • [ ] All new and existing tests passed?
  • [ ] PowerShell code changes: PowerShell v2 compatibility checked?

Related Issue

Fixes #1
Resolves #2

steviecoaster
steviecoaster requested changes Oct 4, 2023
View reviewed changes
st3phhays
st3phhays previously requested changes Oct 4, 2023
View reviewed changes
gep13
gep13 previously requested changes Oct 4, 2023
View reviewed changes
Copy link
Member

@gep13 gep13 left a comment

Choose a reason for hiding this comment

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

I also think we need a complete review of these files to ensure that we are consistent in usage of:

  • Deployment Plan
  • Deployment Step

etc.

@JPRuskin JPRuskin force-pushed the initial-examples branch 2 times, most recently from 9b135a5 to ed26e17 Compare October 9, 2023 15:44
pauby
pauby requested changes Oct 9, 2023
View reviewed changes
Copy link
Member

@pauby pauby left a comment

Choose a reason for hiding this comment

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

Deployments should be Deployment Plan or Deployment Steps. Both, along with Target Groups, are names of things and should be capitalized.

@steviecoaster
Copy link
Contributor

@JPRuskin It looks like you've got everything fixed up here. Can you tidy up the commits on this PR and then we can merge it?

@pauby
Copy link
Member

pauby commented Oct 19, 2023

@steviecoaster The README.md file needs to be updated with similar changes to the rest of the doc. I can't provide any comments on that, I'm assuming because GitHub is seeing it as a binary file.

@JPRuskin JPRuskin force-pushed the initial-examples branch 2 times, most recently from 6d16447 to ec483f4 Compare October 19, 2023 16:56
@pauby
Copy link
Member

pauby commented Oct 20, 2023

As I mentioned, I can't provide any comments on the README.md file, so I'll add them here.

  1. Heading 'Chocolatey Central Management Deployment Examples' should be 'Chocolatey Central Management Deployment Plan Examples'.
  2. Bullet points need to have a full stop at the end.
  3. 'target groups' should be 'Target Groups'.
  4. For further details .... we don't need docs.chocolatey.org in there as it's already a clickable URL.
  5. Contributing -> 'target groups' should be 'Target Groups'
  6. Contributing -> bullet point 2: 'readme' should be 'README'.
  7. Contributing -> bullet points should all end with full stops.

pauby
pauby previously requested changes Oct 20, 2023
View reviewed changes
@JPRuskin
Copy link
Member Author

JPRuskin commented Oct 20, 2023 •
edited
Loading

As I mentioned, I can't provide any comments on the README.md file, so I'll add them here.

FWIW, this should be sorted in all future PRs. Just this one where we're going from the template's UTF16 to UTF8 (like all our other md using repos, as far as I can tell).

Hopefully all of the above have been addressed, now.

@steviecoaster steviecoaster requested review from pauby and gep13 October 20, 2023 17:00
@JPRuskin JPRuskin requested a review from st3phhays October 23, 2023 10:29
@JPRuskin
(#1) Updates Readme with Basic Description
c159d29 
Adds a basic readme with lightweight instructions on importing any old Deployment Plan, along with a friendly "please feel free to contribute" note.
@steviecoaster steviecoaster dismissed pauby’s stale review October 25, 2023 16:23

I have personally verified all requested changes have been made

@steviecoaster steviecoaster dismissed stale reviews from gep13 and st3phhays October 25, 2023 16:24

I have personally verified all requested changes

@JPRuskin
(#2) Adds Initial Examples
3a0f98a 
This commit adds the initial examples to the repository.

Also updates to "Deployment Plans" rather than "Deployment(s)"
@steviecoaster steviecoaster merged commit 9517a77 into main Oct 25, 2023
@JPRuskin JPRuskin deleted the initial-examples branch October 25, 2023 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@steviecoaster steviecoaster steviecoaster approved these changes

@pauby pauby Awaiting requested review from pauby

@gep13 gep13 Awaiting requested review from gep13

@st3phhays st3phhays Awaiting requested review from st3phhays

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing Example Deployments Missing README Details
5 participants
@JPRuskin @steviecoaster @pauby @gep13 @st3phhays