(#49) Add migration page #50
Conversation
Migrating-AU-to-Chocolatey-AU.md
Outdated
|
|
||
| ## Updating Your Update Scripts | ||
|
|
||
| Once you have updated your repository to use the new module name, you will need to update your `update.ps1` scripts to use the new module name. This is as simple as replacing `AU` with `Chocolatey-AU` for any call to `Import-Module`, or any `#requires -Modules` in you `update.ps1` scripts. |
There was a problem hiding this comment.
Also worth mentioning that if there is an import-module au in the update_all.ps1, it should be updated as well.
There was a problem hiding this comment.
Good catch. I've updated this to just specify updating it in your scripts so we're not calling out specific scripts.
|
In all the docs we've created, we add the URL's to the text as we're writing it rather than at the bottom (there's a name for that, and I cannot remember it). Can you add the URL's where the text is at? Can you also change AU to |
There was a problem hiding this comment.
When writing documentation, refer to the Language and Grammar page of the Design docs. It has some requirements when writing headings.
corbob
force-pushed
the
49-add-a-migration-guide-type-document
branch
from
c0158d8 to
08f5c3f
Compare
corbob
force-pushed
the
49-add-a-migration-guide-type-document
branch
from
08f5c3f to
91f9127
Compare
Co-authored-by: Paul Broadwith <[email protected]>
Update the names in README.md to Chocolatey-AU. Link to the files within the repository using relative links instead of directly to the repository. This will allow links to go to the correct versions instead of just the latest version.
corbob
force-pushed
the
49-add-a-migration-guide-type-document
branch
from
91f9127 to
f32b66d
Compare
corbob
force-pushed
the
49-add-a-migration-guide-type-document
branch
from
f32b66d to
399292c
Compare
There was a problem hiding this comment.
LGTM, but I'll leave it up to @pauby to have a final look over it.
| @@ -51,37 +51,37 @@ To set up plugin to create gist under your user name you need to give it your gi | |||
| 2. Select a `Custom` Integration | |||
| 3. Copy the unique webhook url listed in the dialog. | |||
| 4. Update your appveyor environment variable with your unique webhook, and set the name to `gitter_webhook`. | |||
| 5. Navigate to the `update_all.ps1` file in your repository, and update the `$Options` hashtable with the following | |||
| 5. Navigate to the `update_all.ps1` file in your repository, and update the `$Options` hashtable with the following | |||
There was a problem hiding this comment.
This is just to note it, nothing needs to change.
The two trailing spaces would be deliberate here, it is forcing a line break if the Markdown parser uses soft line breaks.
GitHub seems to handle it though, but if we want this in other places at some point we might want to revert this change.
|
Thanks for doing this @corbob ! |
Description Of Changes
Add a page for migrating from AU to Chocolatey AU.
Motivation and Context
See #49
Testing
N/A
Operating Systems Testing
N/A
Change Types Made
Change Checklist
Related Issue
Fixes #49