Skip to content

Commit

Permalink
Merge branch 'prophen-prophen-404'
Browse files Browse the repository at this point in the history
resolve merge conflict
  • Loading branch information
prophen committed Aug 2, 2021
2 parents 1338387 + e1a75ae commit 8454c5c
Show file tree
Hide file tree
Showing 28 changed files with 128 additions and 236 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,18 @@
# Welcome Contributors!
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.

## Get Started
Let's start with gathering our existing contributor guidelines.

Relevant resources for Spinnaker contributors:
- [Code of Conduct](https://spinnaker.io/docs/community/contributing/code-of-conduct/)
- [Join Us on Slack](http://join.spinnaker.io)
- [Contributing](https://spinnaker.io/docs/community/contributing/)
- [How to Submit a Patch](https://spinnaker.io/docs/community/contributing/submitting/) (includes commit and PR message conventions)
- [Make a Change Using a Local Clone](https://spinnaker.io/docs/community/contributing/local-clone/)
- [Developer How-Tos](https://spinnaker.io/docs/community/contributing/code/developer-guides/)

## Get Involved
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.

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).
1 change: 1 addition & 0 deletions content/en/changelogs/1.24.5-changelog.md
Expand Up @@ -5,6 +5,7 @@ date: 2021-05-27 08:56:51 +0000
tags:
- changelogs
- 1.24
- deprecated
version: 1.24.5
---

Expand Down
17 changes: 17 additions & 0 deletions content/en/changelogs/1.24.6-changelog.md
@@ -0,0 +1,17 @@
---
title: Version 1.24
changelog_title: Version 1.24.6
date: 2021-07-01 20:40:34 +0000
tags:
- changelogs
- 1.24
version: 1.24.6
---

<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.6.md"></script>
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.5.md"></script>
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.4.md"></script>
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.3.md"></script>
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.2.md"></script>
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.1.md"></script>
<script src="https://gist.github.com/spinnaker-release/25abcd046795c6f34bb2d8d4977f0415.js?file=1.24.0.md"></script>
2 changes: 0 additions & 2 deletions content/en/docs/community/contributing/code-of-conduct.md
@@ -1,7 +1,5 @@
---
layout: single
title: 'Code Of Conduct'

aliases:
- /docs/code-of-conduct
---
Expand Down
1 change: 1 addition & 0 deletions content/en/docs/community/contributing/code/_index.md
Expand Up @@ -3,3 +3,4 @@ title: 'Code'
weight: 2
description:
---

3 changes: 0 additions & 3 deletions content/en/docs/community/contributing/code/back-end-code.md
@@ -1,8 +1,5 @@
---
layout: single
title: "Code Languages, Libraries, and Conventions "
sidebar:
nav: community
description: >
This page introduces the foundations Spinnaker services are built on, and code conventions the community has adopted.
---
Expand Down
5 changes: 5 additions & 0 deletions content/en/docs/community/contributing/docs/_index.md
@@ -0,0 +1,5 @@
---
title: 'Docs'
weight: 3
description: "Guides for contributing to the Spinnaker documentation."
---
10 changes: 5 additions & 5 deletions content/en/docs/community/contributing/docs/github-changes.md
Expand Up @@ -10,12 +10,12 @@ sidebar:
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.
1. Click the **Edit this file...** pencil icon to edit the file.

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

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

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

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

Expand All @@ -27,22 +27,22 @@ sidebar:

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

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

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:

```
docs(plugins): add documentation for plugin creators
```

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).
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" >}}).

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!
3. Leave the **Allow edits from maintainers** checkbox selected.

1. Click the **Create pull request** button.

Congratulations! You can view your submitted pull request on the **Pull requests** [tab](https://github.com/spinnaker/spinnaker.github.io/pulls).
Congratulations! You can view your submitted pull request on the **Pull requests** [tab](https://github.com/spinnaker/spinnaker.io/pulls).

## Address feedback in GitHub

Expand Down
182 changes: 0 additions & 182 deletions content/en/docs/community/contributing/docs/index.md

This file was deleted.

Expand Up @@ -150,19 +150,15 @@ hugo server

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.

![CompareAndPullRequest](/assets/images/community/contributing/docs/compare-and-pr.jpg)

1. Click **Compare & pull request**. This takes you to the **Open a pull request** screen.

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

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:

```
docs(plugins): add documentation for plugin creators
```

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).
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" >}}).

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!
3. Leave the **Allow edits from maintainers** checkbox selected.
Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/community/contributing/docs/reviewing-prs.md
Expand Up @@ -7,17 +7,17 @@ sidebar:

## Review a Pull request

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.
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.

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.

## Before you begin

Before reviewing documentation, do the following:

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

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.
1. Review the [Code of Conduct]({{< ref "code-of-conduct" >}}) and ensure that you abide by it at all times.
2. Be polite, helpful, and considerate of others.
3. Comment on positive aspects of a PR, as well as changes.
4. Be empathetic and mindful of how your changes or review may be received.
Expand All @@ -28,7 +28,7 @@ Read the [documentation style guide](/community/contributing/docs/docs-style-gui

## Start the review process

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

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

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

Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/guides/developer/plugin-creator/_index.md
Expand Up @@ -3,6 +3,8 @@ title: "Plugin Creator Guide"
no_list: true
description: >
Plugins enable operators to extend Spinnaker with custom functionality.
aliases:
- /docs/guides/developer/plugin-creators/overview/
---

## What plugins do
Expand Down

0 comments on commit 8454c5c

Please sign in to comment.