Skip to content

Commit

Permalink
docs: fix all broken links (#395)
Browse files Browse the repository at this point in the history
Using markdown-link-check I was able to find all of the broken links in the documentation. I also fixed up any linting errors I could find in the process.

Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
  • Loading branch information
Matthew Fisher authored Jan 29, 2019
1 parent 43b8a9f commit ee49afb
Show file tree
Hide file tree
Showing 18 changed files with 344 additions and 313 deletions.
5 changes: 2 additions & 3 deletions docs/community/planning-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ aks-engine features a lightweight process that emphasizes openness and ensures e

## Open Roadmap

The [aks-engine Roadmap](roadmap.md) is a community document. While Maintainers propose the Roadmap, it gets discussed and refined in Release Planning Meetings.
The [AKS Engine Backlog](https://github.com/Azure/aks-engine/projects/2) is a community document. While Maintainers propose the Roadmap, it gets discussed and refined in Release Planning Meetings.

## Contributing to the Roadmap

Proposals and issues can be opened by anyone. Every member of the community is welcome to participate in the discussion by providing feedback and/or offering counter-proposals.

## Release Milestones

The Roadmap gets delivered progressively via the [Release Schedule][]. Releases are defined during Release Planning Meetings and managed using GitHub Milestones which track specific deliverables and work-in-progress.
The Roadmap gets delivered progressively via the Release Schedule. Releases are defined during Release Planning Meetings and managed using GitHub Milestones which track specific deliverables and work-in-progress.

## Release Planning Meetings

Expand All @@ -25,4 +25,3 @@ Major decisions affecting the Roadmap are discussed during Release Planning Meet
Release Planning Meetings are not currently open to non-Microsoft contributors, but we may change this in the future.

[Maintainers]: https://github.com/Azure/aks-engine/blob/master/OWNERS
[Release Schedule]: releases.md
11 changes: 4 additions & 7 deletions docs/community/release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ projects that do [semantic version][] releases.
aks-engine has a regular, public release cadence. From v0.1.0 onward, new aks-engine feature
releases arrive on the first Thursday of each month. Patch releases are created at any time,
as needed. GitHub milestones are used to communicate the content and timing of major and minor
releases, and longer-term planning is visible at [the Roadmap](roadmap.md).
releases, and longer-term planning is visible at [the Roadmap](planning-process.md#open-roadmap).

aks-engine release timing is not linked to specific features. If a feature is merged before the
release date, it is included in the next release.
Expand All @@ -52,6 +52,7 @@ to a patch or to a minor release will not break anything.
This section leads a maintainer through creating an aks-engine release.

### Step 1: Assemble Master Changelog

A change log is a file which contains a curated, chronologically ordered list of changes
for each version of aks-engine, which helps users and contributors see what notable changes
have been made between each version of the project.
Expand All @@ -71,17 +72,13 @@ infrastructure providers.
When showstopper-level bugs are found, the process is as follows:

1. Create an issue that describes the bug.
1. Create an PR that fixes the bug.
- PRs should always include tests (unit or e2e as appropriate) to add
automated coverage for the bug.
1. Create an PR that fixes the bug. PRs should always include tests (unit or e2e as appropriate) to add automated coverage for the bug.
1. Once the PR passes and is reviewed, merge it and update the CHANGELOG


### Step 3: Tag and Create a Release

TBD


### Step 4: Close GitHub Milestones

TBD
Expand All @@ -92,7 +89,7 @@ Let the rest of the team know they can start blogging and tweeting about the new
Post a message to the #company channel on Slack. Include a link to the released chart and to the
master CHANGELOG:

```
```text
@here aks-engine 0.1.0 is here!
Master CHANGELOG: https://github.com/Azure/aks-engine/CHANGELOG.md
```
Expand Down
12 changes: 7 additions & 5 deletions docs/howto/building-windows-kubernetes-binaries.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ The following instructions show how to deploy the Windows Kubernetes Binaries an

### Prerequisites

* Azure Storage Account and Azure Storage Container to store Windows binaries
* Access to [wincni.exe] and [hns.psm1] (https://github.com/Microsoft/SDN/tree/master/Kubernetes/windows/). Windows CNI is a plugin that supports the Container Network Interface (CNI) network model and interfaces with the Windows Host Networking Service (HNS) to configure host networking and policy.
* Docker installed and running. MacOS users using Docker for Mac must have at [least 3GB of memory allocated to Docker](https://github.com/kubernetes/kubernetes/tree/master/build/#requirements) or building will likely fail.
- Azure Storage Account and Azure Storage Container to store Windows binaries
- Access to [wincni.exe] and [hns.psm1](https://github.com/Microsoft/SDN/tree/master/Kubernetes/windows/). Windows CNI is a plugin that supports the Container Network Interface (CNI) network model and interfaces with the Windows Host Networking Service (HNS) to configure host networking and policy.
- Docker installed and running. MacOS users using Docker for Mac must have at [least 3GB of memory allocated to Docker](https://github.com/kubernetes/kubernetes/tree/master/build/#requirements) or building will likely fail.

[build-windows-k8s.sh](../../scripts/build-windows-k8s.sh) does the following:

[build-windows-k8s.sh](../scripts/build-windows-k8s.sh) does the following:
- Checks out the fork of Azure/kubernetes (includes Windows fixes not yet in upstream Kubernetes, needed for Windows containers to function)
- Builds kubelet.exe and kube-proxy.exe from source in a Docker container
- Downloads kubectl.exe for desired release
Expand All @@ -28,7 +29,8 @@ More information about building Kubernetes binaries from source here: https://gi
### Set Azure Storage credentials and Container name

A storage container is used to upload the resulting archive artifact.
```

```console
$ export AZURE_STORAGE_CONNECTION_STRING="DefaultEndpointsProtocol=https;AccountName=MyStorageAccountName;AccountKey=..." \
AZURE_STORAGE_CONTAINER_NAME=MyStorageContainerName
```
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/mixed-cluster-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Prerequisites

1. First, deploy a cluster with both Windows & Linux nodes. See the [Kubernetes Windows Walkthrough](windows.md) for a step by step example.
1. First, deploy a cluster with both Windows & Linux nodes. See the [Kubernetes Windows Walkthrough](../topics/windows.md) for a step by step example.
1. Install [Helm](http://helm.sh), the Kubernetes package manager

## Steps
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/aad.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You also need to delegate permission to the application as follows:


## Deployment
Follow the [deployment steps](../kubernetes.md#deployment). In step #4, add the following under 'properties' section:
Follow the [deployment steps](../tutorials/deploy.md). In step #4, add the following under 'properties' section:
```json
"aadProfile": {
"serverAppID": "",
Expand Down
Loading

0 comments on commit ee49afb

Please sign in to comment.