Skip to content

Commit 8454c5c

Browse files
committed
Merge branch 'prophen-prophen-404'
resolve merge conflict
2 parents 1338387 + e1a75ae commit 8454c5c

File tree

28 files changed

+128
-236
lines changed

28 files changed

+128
-236
lines changed

CONTRIBUTING.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Welcome Contributors!
2+
Thank you for considering contributing to the Spinnaker project's documentation. This is a working document, be sure to check back soon for updates and additions.
3+
4+
## Get Started
5+
Let's start with gathering our existing contributor guidelines.
6+
7+
Relevant resources for Spinnaker contributors:
8+
- [Code of Conduct](https://spinnaker.io/docs/community/contributing/code-of-conduct/)
9+
- [Join Us on Slack](http://join.spinnaker.io)
10+
- [Contributing](https://spinnaker.io/docs/community/contributing/)
11+
- [How to Submit a Patch](https://spinnaker.io/docs/community/contributing/submitting/) (includes commit and PR message conventions)
12+
- [Make a Change Using a Local Clone](https://spinnaker.io/docs/community/contributing/local-clone/)
13+
- [Developer How-Tos](https://spinnaker.io/docs/community/contributing/code/developer-guides/)
14+
15+
## Get Involved
16+
Once you join Slack, make yourself at home! Feel free to ask questions, start conversations, and flag issues that need attention. Join the #sig-contributor-experience channel to receive a warm welcome.
17+
18+
Browse the channels that start with "sig-" to see the project's special interest groups (SIGs). More information on all of the approved SIGs can be found in the [governance repository](https://github.com/spinnaker/governance).

content/en/changelogs/1.24.5-changelog.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ date: 2021-05-27 08:56:51 +0000
55
tags:
66
- changelogs
77
- 1.24
8+
- deprecated
89
version: 1.24.5
910
---
1011

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Version 1.24
3+
changelog_title: Version 1.24.6
4+
date: 2021-07-01 20:40:34 +0000
5+
tags:
6+
- changelogs
7+
- 1.24
8+
version: 1.24.6
9+
---
10+
11+
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.6.md"></script>
12+
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.5.md"></script>
13+
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.4.md"></script>
14+
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.3.md"></script>
15+
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.2.md"></script>
16+
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.1.md"></script>
17+
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.0.md"></script>

content/en/docs/community/contributing/code-of-conduct.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
---
2-
layout: single
32
title: 'Code Of Conduct'
4-
53
aliases:
64
- /docs/code-of-conduct
75
---

content/en/docs/community/contributing/code/_index.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ title: 'Code'
33
weight: 2
44
description:
55
---
6+

content/en/docs/community/contributing/code/back-end-code.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
2-
layout: single
32
title: "Code Languages, Libraries, and Conventions "
4-
sidebar:
5-
nav: community
63
description: >
74
This page introduces the foundations Spinnaker services are built on, and code conventions the community has adopted.
85
---
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: 'Docs'
3+
weight: 3
4+
description: "Guides for contributing to the Spinnaker documentation."
5+
---

content/en/docs/community/contributing/docs/github-changes.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ sidebar:
1010
1. Click the **Suggest an Edit** link on the documentation page you want to update. This takes you to the page's source file in GitHub.
1111
1. Click the **Edit this file...** pencil icon to edit the file.
1212

13-
![EditFileIcon](/assets/images/community/contributing/docs/github-edit-file-icon.jpg)
13+
![EditFileIcon](/images/community/contributing/docs/github-edit-file-icon.jpg)
1414

1515
1. Make your changes in the GitHub markdown editor.
1616
1. Fill in the **Propose file change** form.
1717

18-
![ProposeFileChange](/assets/images/community/contributing/docs/github-propose-file-change-form.jpg)
18+
![ProposeFileChange](/images/community/contributing/docs/github-propose-file-change-form.jpg)
1919

2020
1. Explain what your file change is about in a short summary.
2121

@@ -27,22 +27,22 @@ sidebar:
2727

2828
1. Fill in the **Open a pull request** form.
2929

30-
![OpenPullRequest](/assets/images/community/contributing/docs/github-open-pull-request.jpg)
30+
![OpenPullRequest](/images/community/contributing/docs/github-open-pull-request.jpg)
3131

3232
1. The **Title** defaults to the file change summary. Update the title so it follows the `<type>(<scope>): <subject>` format. Make sure you include a space after the colon. For example:
3333

3434
```
3535
docs(plugins): add documentation for plugin creators
3636
```
3737
38-
The Spinnaker repositories use a PR title checker, so your PR will fail if the title is not in the correct format. For more information, see [commit message conventions](/community/contributing/submitting/#commit-message-conventions).
38+
The Spinnaker repositories use a PR title checker, so your PR will fail if the title is not in the correct format. For more information, see [commit message conventions]({{< ref "submitting#commit-message-conventions" >}}).
3939
4040
2. The **Leave a comment** field defaults to the file change description. PR descriptions are the first step to helping reviewers and project maintainers understand why your change was made. Do not leave this field blank. Provide as much description as possible. A good description helps get your PR merged faster!
4141
3. Leave the **Allow edits from maintainers** checkbox selected.
4242
4343
1. Click the **Create pull request** button.
4444
45-
Congratulations! You can view your submitted pull request on the **Pull requests** [tab](https://github.com/spinnaker/spinnaker.github.io/pulls).
45+
Congratulations! You can view your submitted pull request on the **Pull requests** [tab](https://github.com/spinnaker/spinnaker.io/pulls).
4646
4747
## Address feedback in GitHub
4848

content/en/docs/community/contributing/docs/index.md

-182
This file was deleted.

content/en/docs/community/contributing/local-clone.md renamed to content/en/docs/community/contributing/docs/local-clone.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -150,19 +150,15 @@ hugo server
150150

151151
1. In a web browser, go to the `spinnaker/spinnaker.io` [repository](https://github.com/spinnaker/spinnaker.io). You should see your recently pushed working branch with a **Compare & pull request** button.
152152

153-
![CompareAndPullRequest](/assets/images/community/contributing/docs/compare-and-pr.jpg)
154-
155153
1. Click **Compare & pull request**. This takes you to the **Open a pull request** screen.
156154

157-
![OpenPullRequest](/assets/images/community/contributing/docs/github-open-pull-request.jpg)
158-
159155
1. The **Title** defaults to the commit subject. Update the title so it follows the `<type>(<scope>): <subject>` format. Make sure you include a space after the colon. For example:
160156

161157
```
162158
docs(plugins): add documentation for plugin creators
163159
```
164160

165-
The Spinnaker repositories use a PR title checker, so your PR will fail if the title is not in the correct format. For more information, see [commit message conventions](/community/contributing/submitting/#commit-message-conventions).
161+
The Spinnaker repositories use a PR title checker, so your PR will fail if the title is not in the correct format. For more information, see [commit message conventions]({{< ref "submitting#commit-message-conventions" >}}).
166162

167163
2. The **Leave a comment** field defaults to the commit description. Pull request descriptions are the first step to helping reviewers and project maintainers understand why your change was made. Do not leave this field blank. Provide as much description as possible. A good description helps get your PR merged faster!
168164
3. Leave the **Allow edits from maintainers** checkbox selected.

content/en/docs/community/contributing/docs/reviewing-prs.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ sidebar:
77

88
## Review a Pull request
99

10-
Anyone can review a documentation pull request (PR). Visit the [**Pull requests**](https://github.com/spinnaker/spinnaker.github.io/pulls) section in the Spinnaker website repository to see a list of all currently open pull requests.
10+
Anyone can review a documentation pull request (PR). Visit the [Pull requests](https://github.com/spinnaker/spinnaker.io/pulls) section in the Spinnaker website repository to see a list of all currently open pull requests.
1111

1212
Reviewing documentation pull requests is a great way to get started contributing to the Spinnaker community. It helps you to learn the code base and builds rapport with other contributors.
1313

1414
## Before you begin
1515

1616
Before reviewing documentation, do the following:
1717

18-
Read the [documentation style guide](/community/contributing/docs/docs-style-guide/) so that you can leave informed feedback.
18+
Read the [documentation style guide]({{< ref "docs-style-guide" >}}) so that you can leave informed feedback.
1919

20-
1. Review the [code of conduct](https://github.com/spinnaker/spinnaker.github.io/blob/master/community/contributing/code-of-conduct.md) and ensure that you abide by it at all times.
20+
1. Review the [Code of Conduct]({{< ref "code-of-conduct" >}}) and ensure that you abide by it at all times.
2121
2. Be polite, helpful, and considerate of others.
2222
3. Comment on positive aspects of a PR, as well as changes.
2323
4. Be empathetic and mindful of how your changes or review may be received.
@@ -28,7 +28,7 @@ Read the [documentation style guide](/community/contributing/docs/docs-style-gui
2828

2929
## Start the review process
3030

31-
1. Go to (<https://github.com/spinnaker/spinnaker.github.io/pulls>) to see a list of all current open PRs in the Spinnaker repository.
31+
1. Go to (<https://github.com/spinnaker/spinnaker.io/pulls>) to see a list of all current open PRs in the Spinnaker repository.
3232

3333
2. Filter the open PRs using one or all of the following labels:
3434

@@ -64,7 +64,7 @@ When reviewing a PR, use the following questions as a starting point:
6464
- Are there any obvious errors in grammar or language?
6565
- Is there a better way to phrase something?
6666
- Are there words, phrases, or terms that should be replaced with a non-discriminatory alternative?
67-
- Does the word choice, punctuation, and capitalization follow the [style guide](/community/contributing/docs/docs-style-guide/)?
67+
- Does the word choice, punctuation, and capitalization follow the [style guide]({{< ref "docs-style-guide" >}})?
6868
- Are there long sentences which could be shorter or made less complex?
6969
- Are there long paragraphs which would work better as a bulleted list or table?
7070

content/en/docs/guides/developer/plugin-creator/_index.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: "Plugin Creator Guide"
33
no_list: true
44
description: >
55
Plugins enable operators to extend Spinnaker with custom functionality.
6+
aliases:
7+
- /docs/guides/developer/plugin-creators/overview/
68
---
79

810
## What plugins do

0 commit comments

Comments
 (0)