(#970) Publish new Organizational Deployment Guide #1239
Merged
+2,539
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit puts the new org guide document in place with the proper nav menu structure so we can begin working on the content of the doc.
Co-authored-by: James Ruskin <github@justpowerdown.com> Co-authored-by: Chris White <imm0rtalsupp0rt@users.noreply.github.com> Co-authored-by: Ryan Richter <ryanrichter94@users.noreply.github.com>
The introduction on the landing page has been added and the formatting for the repository solutions pages has been improved
… on the new org guide appropriately.
The C4B version of the organizational guide now has its own mdx file with some useful content, and the introduction page has been reworked to show what the guide intends.
Creates a better intro with a card that clicks into the actual setup documentation.
This adds the Chocolatey logo to both cards on the new org guide landing page which directs people to setup Open Source Chocolatey or Chocolatey For Business
Remove SQL server info from docs, put onus on user to have SQL configured properly prior to installation. Simplified and standardized instructions across all components
This commit breaks out the installation of SQL Server Express into its own component and streamlines it for use within the Organizational Deployment Guide. There were also some minor typos corrected within other Organizational Deployment Guide documentation.
This adds the Certificate parameters used for CCM setup to the new org guide. Additionally, information about SSL security is added for informational purposes.
Transferred the Sonatype Nexus repository install Ryan wrote to a newly created page with tabs to replicate the functionality of the Jenkins install page. Renamed components for consistency.
…n navigation I've refactored the Organizational Deployment Guide into a folder/file structure to nest the various components beneath the introduction page. I've included button navigation to go back and forth between pages as well as a button to start from the beginning, and have included a button to navigate to Client Setup once that has been included. This commit also includes minor typo fixes and expansion of acronyms and initialisms.
Upon Stephen's recommendation, I placed the callout for the offline Jenkins installation before the installation script to mimic the Nexus page, and I combined the sentences about the raw repository creation to emphasize that a single raw repository is created for two purposes.
The table structure that was present for the variables on the Jenkins document has been ported over onto the Nexus document for consistency. Additional variables for the Nexus document were added to mimic the variables available on the script. I also rewrote the descriptions for what the variables do in order to maintain consistent voice between the two pages.
…sistency Using the Style Guide, I refactored the newly added Client Setup document and the CCM document for layout consistency. This included an additional component MDX and a card with an image for Chocolatey for Business.
This commit added the Bootstrap script to allow testing of the Org Guide, and the image representing the Sonatype Nexus Repository solution was changed for consistency with the Jenkins image.
This commit removes the Credential parameter from the Sonatype Nexus install script as it is no longer necessary.
This commit adds the Thumbprint parameter to the Jenkins script as it is in the Nexus script, and adds callouts to tell users to install their SSL certificate in the Local Machine \ Trusted People store of the server.
If the -Thumbprint parameter is passed when running the Org Guide, an SSL certificate must be present in the Local Machine / Trusted People store. This commit adds instructions to import the SSL certificate in an expandable list in case users need it.
Corrected sentence structure and typos on SSL certificate import instructions.
This commit added dynamic code blocks for the Chocolatey Central Management scripts and adjusted language for SSL certificate requirement across the entire Org Guide.
This commit has several removals of parameters from the scripts themselves in order to make configuration simpler.
The decision was made to hardcode the connection strings for the CCM Org Guide scripts.
This commit addresses changes that were needed to the parameters for Client Setup as well as calling the ClientSetup script via web request.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description Of Changes
The new Organizational Deployment Guide provides a streamlined process for customers to set up their Chocolatey for Business environment on a single server or multiple servers, depending on their preferences.
Motivation and Context
The old Organizational Deployment Guide was too long and convoluted, and many customers struggled when attempting to use it. The Chocolatey Support and Solutions team aimed to simplify the process and make it easier for customers to navigate.
Testing
Change Types Made
Change Checklist
Related Issue
Fixes #970