Skip to content

Commit 3dbd1c6

Browse files
authored
Fix failures in GitHub action markdown-link-check (#20996)
1 parent c3eedde commit 3dbd1c6

File tree

4 files changed

+18
-22
lines changed

4 files changed

+18
-22
lines changed

CHANGELOG/preview.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Preview Changelog
2+
3+
Information about PowerShell previews will be found in this file

docs/git/README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,22 @@ git clone https://github.com/PowerShell/PowerShell.git --branch=master
1313
* Checkout a new local branch from `master` for every change you want to make (bugfix, feature).
1414
* Use lowercase-with-dashes for naming.
1515
* Follow [Linus' recommendations][Linus] about history.
16-
- "People can (and probably should) rebase their _private_ trees (their own work). That's a _cleanup_. But never other peoples code. That's a 'destroy history'...
17-
You must never EVER destroy other peoples history. You must not rebase commits other people did.
18-
Basically, if it doesn't have your sign-off on it, it's off limits: you can't rebase it, because it's not yours."
16+
* "People can (and probably should) rebase their _private_ trees (their own work). That's a _cleanup_. But never other peoples code. That's a 'destroy history'...
17+
You must never EVER destroy other peoples history. You must not rebase commits other people did.
18+
Basically, if it doesn't have your sign-off on it, it's off limits: you can't rebase it, because it's not yours."
1919

2020
### Understand branches
2121

2222
* **master** is the branch with the latest and greatest changes.
2323
It could be unstable.
2424
* Send your pull requests to **master**.
2525

26-
### Sync your local repo
26+
### Sync your local repository
2727

2828
Use **git rebase** instead of **git merge** and **git pull**, when you're updating your feature-branch.
2929

3030
```sh
31-
# fetch updates all remote branch references in the repo
31+
# fetch updates all remote branch references in the repository
3232
# --all : tells it to do it for all remotes (handy, when you use your fork)
3333
# -p : tells it to remove obsolete remote branch references (when they are removed from remote)
3434
git fetch --all -p
@@ -42,9 +42,7 @@ git rebase origin/master
4242
Covering all possible git scenarios is behind the scope of the current document.
4343
Git has excellent documentation and lots of materials available online.
4444

45-
We are leaving few links here:
46-
47-
[Git pretty flowchart](http://justinhileman.info/article/git-pretty/): what to do, when your local repo became a mess.
45+
We are leaving a few links here:
4846

4947
[Linus]:https://wincent.com/wiki/git_rebase%3A_you're_doing_it_wrong
5048

@@ -57,12 +55,12 @@ you will find it via **tags**.
5755
* Find the tag that corresponds to the release.
5856
* Use `git checkout <tag-name>` to get this version.
5957

60-
**Note:** [checking out a tag][tag] will move the repo to a [DETACHED HEAD][HEAD] state.
58+
**Note:** [checking out a tag][tag] will move the repository to a [DETACHED HEAD][HEAD] state.
6159

6260
[tag]:https://git-scm.com/book/en/v2/Git-Basics-Tagging#Checking-out-Tags
6361
[HEAD]:https://www.git-tower.com/learn/git/faq/detached-head-when-checkout-commit
6462

65-
If you want to make changes, based on tag's version (i.e. a hotfix),
63+
If you want to make changes, based on tag's version (i.e. a hotfix),
6664
checkout a new branch from this DETACHED HEAD state.
6765

6866
```sh

docs/maintainers/releasing.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,15 @@ This is to help track the release preparation work.
2121
- Sign the MSI packages and DEB/RPM packages.
2222
- Install and verify the packages.
2323
1. Update documentation, scripts and Dockerfiles
24-
- Summarize the change log for the release. It should be reviewed by PM(s) to make it more user-friendly.
25-
- Update [CHANGELOG.md](../../CHANGELOG.md) with the finalized change log draft.
24+
- Summarize the changelog for the release. It should be reviewed by PM(s) to make it more user-friendly.
25+
- Update [CHANGELOG.md](../../CHANGELOG.md) with the finalized changelog draft.
2626
- Update other documents and scripts to use the new package names and links.
2727
1. Verify the release Dockerfiles.
2828
1. [Create NuGet packages](#nuget-packages) and publish them to [powershell-core feed][ps-core-feed].
2929
1. [Create the release tag](#release-tag) and push the tag to `PowerShell/PowerShell` repository.
30-
1. Create the draft and publish the release in Github.
30+
1. Create the draft and publish the release in GitHub.
3131
1. Merge the `release-<Release Tag>` branch to `master` in `powershell/powershell` and delete the `release-<Release Tag>` branch.
3232
1. Publish Linux packages to Microsoft YUM/APT repositories.
33-
1. Trigger the release docker builds for Linux and Windows container images.
34-
- Linux: push a branch named `docker` to `powershell/powershell` repository to trigger the build at [powershell docker hub](https://hub.docker.com/r/microsoft/powershell/builds/).
35-
Delete the `docker` branch once the builds succeed.
36-
- Windows: queue a new build in `PowerShell Windows Docker Build` on VSTS.
37-
1. Verify the generated docker container images.
3833
1. [Update the homebrew formula](#homebrew) for the macOS package.
3934
This task usually will be taken care of by the community,
4035
so we can wait for one day or two and see if the homebrew formula has already been updated,
@@ -104,7 +99,7 @@ this package will contain actual PowerShell bits
10499
(i.e. it is not a meta-package).
105100
These bits are installed to `/opt/microsoft/powershell/6.0.0-alpha.8/`,
106101
where the version will change with each update
107-
(and is the pre-release version).
102+
(and is the prerelease version).
108103
On macOS, the prefix is `/usr/local`,
109104
instead of `/opt/microsoft` because it is derived from BSD.
110105

@@ -173,7 +168,7 @@ Start-PSPackage -Type zip -ReleaseTag v6.0.0-beta.1 -WindowsRuntime 'win7-x64'
173168

174169
## NuGet Packages
175170

176-
The NuGet packages for hosting PowerShell for Windows and non-Windows are being built in our release build pipeline.
171+
The NuGet packages for hosting PowerShell for Windows and non-Windows are being built-in our release build pipeline.
177172
The assemblies from the individual Windows and Linux builds are consumed and packed into NuGet packages.
178173
These are then released to [powershell-core feed][ps-core-feed].
179174

@@ -190,7 +185,7 @@ we create an [annotated tag][tag] that names the release.
190185
An annotated tag has a message (like a commit),
191186
and is *not* the same as a lightweight tag.
192187
Create one with `git tag -a v6.0.0-alpha.7 -m <message-here>`,
193-
and use the release change logs as the message.
188+
and use the release changelogs as the message.
194189
Our convention is to prepend the `v` to the semantic version.
195190
The summary (first line) of the annotated tag message should be the full release title,
196191
e.g. 'v6.0.0-alpha.7 release of PowerShellCore'.

tools/performance/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
This directory contains useful scripts and related files for analyzing PowerShell performance.
55

6-
If you use the [Windows Performance Toolkit](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk), you can use the following to collect data and analyze a trace.
6+
If you use the [Windows Performance Toolkit](https://learn.microsoft.com/windows-hardware/test/wpt/), you can use the following to collect data and analyze a trace.
77

88
```PowerShell
99
$PowerShellGitRepo = "D:\PowerShell"

0 commit comments

Comments
 (0)