Skip to content

Commit

Permalink
Merge pull request #2101 from carolynvs/sync-from-main
Browse files Browse the repository at this point in the history
Sync from main
  • Loading branch information
carolynvs authored May 26, 2022
2 parents df3b28c + f8416ae commit b189c85
Show file tree
Hide file tree
Showing 19 changed files with 44 additions and 23 deletions.
5 changes: 5 additions & 0 deletions ADOPTERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,8 @@ Usage: Microsoft uses bundles to share best practices and quickstarts for runnin
Status: Production ✅
Country: Germany 🇩🇪
Usage: We use bundles to handover deliverables to customers in a standardized, reliable, and secure way.

#### [F5](https://www.f5.com)
Status: Internal ✅
Country: United States 🇺🇸
Usage: F5, Inc uses bundles to provide a catalog of best practice architecture references and development environments.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,18 @@ slack, interactions on social media, project meetings, conferences and meetups.

## Find an issue

We have good first issues for new contributors and help wanted issues for our other contributors. When you have been contributing for a while, take a look at the "Backlog" column on our [project board][board] for high priority issues. The project board is at the organization level, so it contains issues from across all of the Porter repositories.
Use the [getporter.org/find-issue] link to find good first issues for new contributors and help wanted issues for our other contributors.

When you have been contributing for a while, take a look at the "Backlog" column on our [project board][board] for high priority issues.
The project board is at the organization level, so it contains issues from across all the Porter repositories.

* [`good first issues`][good-first-issue] has extra information to help you make your first contribution.
* [`help wanted`][help-wanted] are issues suitable for someone who isn't a core maintainer.
* `hmm 🛑🤔` issues should be avoided. They are not ready to be worked on yet
because they are not finished being designed or we aren't sure if we want the
feature, etc.

Maintainers will do their best to regularly make new issues for you to solve and then
Maintainers will do their best to regularly make new issues for you to solve and then
help out as you work on them. 💖

We have a [roadmap] that will give you a good idea of the
Expand All @@ -70,7 +73,8 @@ Another great way to contribute is to create a mixin! You can start using the

When you create your first pull request, add your name to the bottom of our
[Contributors][contributors] list. Thank you for making Porter better! 🙇‍♀️


[getporter.org/find-issue]: https://getporter.org/find-issue/
[contributors]: https://porter.sh/src/CONTRIBUTORS.md
[skeletor]: https://github.com/getporter/skeletor
[mixin-dev-guide]: https://porter.sh/mixin-dev-guide/
Expand Down
7 changes: 6 additions & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,9 @@ and we will add you. **All** contributors belong here. 💯
* [Yingrong Zhao](https://github.com/VinozzZ)
* [Saksham Sharma](https://github.com/sakkshm26)
* [Jeremy Goss](https://github.com/Jemgoss)
* [Chioma Onyekpere](https://github.com/Simpcyclassy)
* [Chioma Onyekpere](https://github.com/Simpcyclassy)
* [Saksham Sharma](https://github.com/sakkshm26)
* [Quentin Petraroia](https://github.com/qpetraroia)
* [Tamir Kamara](https://github.com/tamirkamara)
* [Chioma Onyekpere](https://github.com/Simpcyclassy)
* [Hrittik Roy](https://github.com/hrittikhere)
8 changes: 4 additions & 4 deletions cmd/porter/bundle.go
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
"Name of a parameter set for the bundle. It should be a named set of parameters and may be specified multiple times.")
f.StringArrayVar(&opts.Params, "param", nil,
"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
"Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.")
f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
"Specify a driver to use. Allowed values: docker, debug")
Expand Down Expand Up @@ -227,7 +227,7 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
f.StringArrayVar(&opts.Params, "param", nil,
"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
"Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.")
f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
"Specify a driver to use. Allowed values: docker, debug")
Expand Down Expand Up @@ -286,7 +286,7 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
f.StringArrayVar(&opts.Params, "param", nil,
"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
"Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
"Specify a driver to use. Allowed values: docker, debug")
Expand Down Expand Up @@ -343,7 +343,7 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
f.StringArrayVar(&opts.Params, "param", nil,
"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
"Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
"Specify a driver to use. Allowed values: docker, debug")
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/bundles_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ porter bundles install [INSTALLATION] [flags]
```
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-c, --cred stringArray Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/bundles_invoke.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ porter bundles invoke [INSTALLATION] --action ACTION [flags]
--action string Custom action name to invoke.
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-c, --cred stringArray Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/bundles_uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ porter bundles uninstall [INSTALLATION] [flags]
```
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-c, --cred stringArray Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
--delete Delete all records associated with the installation, assuming the uninstall action succeeds
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/bundles_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ porter bundles upgrade [INSTALLATION] [flags]
```
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-c, --cred stringArray Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ porter install [INSTALLATION] [flags]
```
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-c, --cred stringArray Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/invoke.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ porter invoke [INSTALLATION] --action ACTION [flags]
--action string Custom action name to invoke.
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-c, --cred stringArray Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ porter uninstall [INSTALLATION] [flags]
```
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-c, --cred stringArray Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
--delete Delete all records associated with the installation, assuming the uninstall action succeeds
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ porter upgrade [INSTALLATION] [flags]
```
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-c, --cred stringArray Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
Expand Down
1 change: 1 addition & 0 deletions docs/content/compatible-registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ out a particular registry and know that it will work for you.
| **Harbor 2** | **Yes** |
| Nexus | No |
| Quay | No |
| GitLab | No |

If you test a registry with Porter and find that this page is out of date, [please
let us know](https://github.com/deislabs/porter/issues/new)!
Expand Down
8 changes: 5 additions & 3 deletions docs/content/contribute/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,14 @@ code, build and test it, and then submit your first pull request.
We have a [tutorial] to get your environment setup, make your first change
to Porter, and try it out.

The contributing guide explains how to [find an issue]. We do use
two labels:
You can quickly find suitable issues to work on with the [getporter.org/find-issue] link.
The contributing guide explains how to [find an issue].
We use two labels:

* [good first issue] has extra information to help you make your first contribution.
* [help wanted] are issues suitable for someone who isn't a core maintainer.

[getporter.org/find-issue]: /find-issue/
[conduct]: /src/CODE_OF_CONDUCT.md
[contributing]: /contribute/guide/
[find an issue]: /contribute/guide/#find-an-issue
Expand All @@ -62,7 +64,7 @@ do:

* Add commands to the porter cli. This is work that never ends and is suitable
for all levels of gophers.
* Create a mixin! You can start use the [Porter Skeletor][skeletor] repository
* Create a mixin! You can start using the [Porter Skeletor][skeletor] repository
as a template to start, along with the [Mixin Developer Guide][mixin-dev-guide].
Here's the list of [existing mixins] and [requested mixins].
* Coordinate between writing an upstream CNAB specification, such as security or
Expand Down
2 changes: 2 additions & 0 deletions docs/content/contribute/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,8 @@ Hello Carolyn!
That verifies your change but let's also run the [unit tests] and [end-to-end] tests
to make sure there aren't any regressions.
> In MacOS Monterey, port 5000 is already in use blocking `mage testSmoke` from running properly. To free port 5000, uncheck `AirPlay Receiver` in Sharing under System Preferences.
```
make test-unit
mage testSmoke
Expand Down
6 changes: 3 additions & 3 deletions docs/content/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Set VERSION to the most recent [v1 prerelease] version number.

```bash
export PORTER_HOME=~/.porterv1
export VERSION="v1.0.0-alpha.10"
export VERSION="v1.0.0-alpha.19"
curl -L https://cdn.porter.sh/$VERSION/install-mac.sh | bash
```

Expand All @@ -104,7 +104,7 @@ porter version

```bash
export PORTER_HOME=~/.porterv1
export VERSION="v1.0.0-alpha.10"
export VERSION="v1.0.0-alpha.19"
curl -L https://cdn.porter.sh/$VERSION/install-linux.sh | bash
```

Expand All @@ -121,7 +121,7 @@ porter version

```powershell
$PORTER_HOME="$env:USERPROFILE\.porterv1"
$VERSION="v1.0.0-alpha.10"
$VERSION="v1.0.0-alpha.19"
(New-Object System.Net.WebClient).DownloadFile("https://cdn.porter.sh/$VERSION/install-windows.ps1", "install-porter.ps1")
.\install-porter.ps1 -PORTER_HOME $PORTER_HOME
```
Expand Down
1 change: 1 addition & 0 deletions docs/content/project/short-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: Useful short links to common project resources

The Porter website has a number of useful short links defined to help you quickly navigate to project resources.

* [/find-issue](/find-issue): View all Porter issues labeled with "help wanted" and "good first issue".
* [/board](/board/): The Porter project board, contains issues for all repositories.
* /board/ISSUE+LABEL: View all issues on the Porter project board with the specified label, using a plus sign in place of spaces.
* [/board/good+first+issue](/board/good+first+issue): Good first issues for new contributors.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/quickstart/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Pass credentials to a bundle with the \--cred or -c flag, where the flag value i
For example:

```
porter install --cred github
porter install --cred github --reference getporter/credentials-tutorial:v0.3.0
```

The output of this example bundle prints data from your public GitHub user profile.
Expand Down
1 change: 1 addition & 0 deletions docs/static/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/board/pull-requests https://github.com/pulls?q=is:open+is:pr+user:getporter
/board/* https://github.com/orgs/getporter/projects/1?card_filter_query=label:":splat"
/roadmap https://github.com/getporter/porter/projects/4
/find-issue https://github.com/search?q=org%3Agetporter+label%3A%22good+first+issue%22%2C%22help+wanted%22+no%3Aassignee&state=open&type=Issues

# Redirect source code links
/:repo/src/* https://github.com/getporter/:repo/blob/main/:splat
Expand Down

0 comments on commit b189c85

Please sign in to comment.