diff --git a/.github/ISSUE_TEMPLATE/design_proposal.md b/.github/ISSUE_TEMPLATE/design_proposal.md index 2f60b8c00..b287f1dcf 100644 --- a/.github/ISSUE_TEMPLATE/design_proposal.md +++ b/.github/ISSUE_TEMPLATE/design_proposal.md @@ -23,5 +23,5 @@ Provide other approaches considered prior to deciding on the submitted proposal. If applicable, provide potential implementation details assuming the proposal is accepted. # Checklist -- [ ] An announcement of this proposal has been sent to the Porter mailing list: https://getporter.org/mailing-list +- [ ] An announcement of this proposal has been sent to the Porter mailing list: https://porter.sh/mailing-list - [ ] This proposal has remained open for at least one week, to allow time for community feedback. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c26f2c90d..bd38d70d7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,7 +8,7 @@ Closes # _(issue)_ _If there is not an existing issue, please make sure we have context on why this change is needed. See our Contributing Guide for [examples of when an existing issue isn't necessary][1]._ -[1]: https://getporter.org/src/CONTRIBUTING.md#when-to-open-a-pull-request +[1]: https://porter.sh/src/CONTRIBUTING.md#when-to-open-a-pull-request # Notes for the reviewer _Put any questions or notes for the reviewer here._ @@ -23,4 +23,4 @@ _Put any questions or notes for the reviewer here._ * Comment with /azp run test-porter-release if a magefile or build script was modified * Comment with /azp run porter-integration if it's a non-trivial PR -[contributors]: https://getporter.org/src/CONTRIBUTORS.md \ No newline at end of file +[contributors]: https://porter.sh/src/CONTRIBUTORS.md \ No newline at end of file diff --git a/.github/workflows/atom-template.xml b/.github/workflows/atom-template.xml index 40fd06bd5..98262a301 100644 --- a/.github/workflows/atom-template.xml +++ b/.github/workflows/atom-template.xml @@ -1,11 +1,11 @@ - https://getporter.org/mixins + https://porter.sh/mixins Porter Mixins {{Updated}} Porter Authors - https://getporter.org/mixins + https://porter.sh/mixins {{#Mixins}} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f977683e2..a017e8a4c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -72,4 +72,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html [homepage]: https://www.contributor-covenant.org -[slack]: https://getporter.org/community#slack +[slack]: https://porter.sh/community#slack diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29dbcac9b..890062160 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,7 @@ how things will go. If this is your first contribution to Porter, we have a [tutorial] that walks you through how to setup your developer environment, make a change and test it. -[tutorial]: https://getporter.org/docs/contribute/tutorial/ +[tutorial]: https://porter.sh/docs/contribute/tutorial/ ## Code of Conduct @@ -47,11 +47,11 @@ The Porter community is governed by our [Code of Conduct][coc]. This includes but isn't limited to: the porter and related mixin repositories, slack, interactions on social media, project meetings, conferences and meetups. -[coc]: https://getporter.org/src/CODE_OF_CONDUCT.md +[coc]: https://porter.sh/src/CODE_OF_CONDUCT.md ## Find an issue -Use the [getporter.org/find-issue] link to find good first issues for new contributors and help wanted issues for our other contributors. +Use the [porter.sh/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. @@ -78,16 +78,16 @@ 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://getporter.org/src/CONTRIBUTORS.md +[porter.sh/find-issue]: https://porter.sh/find-issue/ +[contributors]: https://porter.sh/src/CONTRIBUTORS.md [skeletor]: https://github.com/getporter/skeletor -[mixin-dev-guide]: https://getporter.org/mixin-dev-guide/ -[good-first-issue]: https://getporter.org/board/good+first+issue -[help-wanted]: https://getporter.org/board/help+wanted -[board]: https://getporter.org/board -[slack]: https://getporter.org/community#slack -[roadmap]: https://getporter.org/src/README.md#roadmap -[pep]: https://getporter.org/docs/contribute/proposals/ +[mixin-dev-guide]: https://porter.sh/mixin-dev-guide/ +[good-first-issue]: https://porter.sh/board/good+first+issue +[help-wanted]: https://porter.sh/board/help+wanted +[board]: https://porter.sh/board +[slack]: https://porter.sh/community#slack +[roadmap]: https://porter.sh/src/README.md#roadmap +[pep]: https://porter.sh/docs/contribute/proposals/ ## Which branch to use @@ -233,7 +233,7 @@ Porter! After your first pull request is merged, you will be invited to the [Contributors team] which you may choose to accept (or not). Joining the team lets you have issues in GitHub assigned to you. -[canary]: https://getporter.org/install/#canary +[canary]: https://porter.sh/install/#canary [Contributors team]: https://github.com/orgs/getporter/teams/contributors ### Follow-on PR @@ -258,7 +258,7 @@ Our [contribution ladder][ladder] defines the roles and responsibilities for thi project and how to participate with the goal of moving from a user to a maintainer. -[ladder]: https://getporter.org/src/CONTRIBUTION_LADDER.md +[ladder]: https://porter.sh/src/CONTRIBUTION_LADDER.md # Developer Tasks @@ -387,7 +387,7 @@ installed into your bin directory in the root of the repository. You can use ## Plugin Debugging -If you are developing a [plugin](https://getporter.org/plugins/) and you want to +If you are developing a [plugin](https://porter.sh/plugins/) and you want to debug it follow these steps: The plugin to be debugged should be compiled and placed in porters plugin path @@ -435,7 +435,7 @@ a new blog post and then preview it: 1. Go to /docs/content/blog and create a new file. Whatever you name the file will be the last part of the URL. For example a file named "porter-collaboration.md" will be located at - . + . 1. At the top of the file copy and paste the frontmatter template below. The frontmatter is YAML that instucts the blogging software, Hugo, how to render the @@ -498,7 +498,7 @@ On the Jaeger dashboard, select "porter" from the service drop down, and click " The smoke and integration tests will run with telemetry enabled when the PORTER_TEST_TELEMETRY_ENABLED environment variable is true. -[otel-jaeger bundle]: https://getporter.org/examples/src/otel-jaeger +[otel-jaeger bundle]: https://porter.sh/examples/src/otel-jaeger ## Debug Smoke Tests @@ -522,7 +522,7 @@ If you are using GoLand, use the **Go Remote** debug configuration and make sure ## Command Documentation -Our commands are documented at and that documentation is +Our commands are documented at and that documentation is generated by our CLI. You should regenerate that documentation when you change any files in **cmd/porter** by running `mage DocsGen` which is run every time you run `mage build`. @@ -593,7 +593,7 @@ dependency injection and testing strategies. * **templates**: files that need to be compiled into the porter binary with version command. * **scripts**: - * **install**: Porter [installation](https://getporter.org/install) scripts + * **install**: Porter [installation](https://porter.sh/install) scripts * **tests** have Go-based integration tests. ## Logging @@ -656,8 +656,8 @@ When you realize that you may need to make a breaking change, discuss it with a Here are some examples of breaking changes: * The schema of porter.yaml changed. -* The schema of Porter's [file formats](https://getporter.org/references/file-formats) changed. -* The schema of Porter's [config file](https://getporter.org/configuration/#config-file) changed. +* The schema of Porter's [file formats](https://porter.sh/references/file-formats) changed. +* The schema of Porter's [config file](https://porter.sh/configuration/#config-file) changed. * Flags or behavior of a CLI command changed, such as removing a flag or adding a validation that can result in a hard error, preventing the command from running. All of Porter's documents have a schemaVersion field and when the schema of the document is changed, the version number should be incremented as well in the default set on new documents, the supported schema version constant in the code, and in the documentation for that document. @@ -683,6 +683,6 @@ See the [Custom Windows CI Agent] documentation for details on how the agent is Our [version strategy] explains how we version the project, when you should expect breaking changes in a release, and the process for the v1 release. -[cdn]: https://getporter.org/src/infra/cdn.md -[version strategy]: https://getporter.org/references/version-strategy/ -[Custom Windows CI Agent]: https://getporter.org/src/infra/custom-windows-ci-agent.md +[cdn]: https://porter.sh/src/infra/cdn.md +[version strategy]: https://porter.sh/references/version-strategy/ +[Custom Windows CI Agent]: https://porter.sh/src/infra/custom-windows-ci-agent.md diff --git a/CONTRIBUTION_LADDER.md b/CONTRIBUTION_LADDER.md index 780aa2287..2f9bf8185 100644 --- a/CONTRIBUTION_LADDER.md +++ b/CONTRIBUTION_LADDER.md @@ -31,7 +31,7 @@ Here are some ideas for how you can be more involved and participate in the comm They must follow our [Code of Conduct](CODE_OF_CONDUCT.md). -[slack]: https://getporter.org/community#slack +[slack]: https://porter.sh/community#slack ## Contributor diff --git a/README.md b/README.md index b05044432..9d3e30228 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![CNCF Sandbox Project](docs/static/images/cncf-sandbox-badge.svg)](https://www.cncf.io/projects/porter/) [![porter](https://github.com/getporter/porter/actions/workflows/porter.yml/badge.svg?branch=main&event=push)](https://github.com/getporter/porter/actions/workflows/porter.yml) - + # Porter @@ -10,37 +10,37 @@ Package your application, client tools, configuration, and deployment logic into an installer that you can distribute and run with a single command. Based on the Cloud Native Application Bundle Specification, [CNAB](https://deislabs.io/cnab), Porter provides a declarative authoring experience that lets you focus on what you know best: your application. -

Learn all about Porter at getporter.org

+

Learn all about Porter at porter.sh

# Porter Mixins Mixins provide out-of-the-box support for interacting with different tools and services from inside a bundle. You can always create a mixin, or use the exec mixin and a Custom Dockerfile if a custom mixin doesn't exist yet. -[Porter Mixins](https://getporter.org/mixins/) are available for below platform's: +[Porter Mixins](https://porter.sh/mixins/) are available for below platform's: | Platform | Supported? | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------: | -| [Docker](https://getporter.org/mixins/docker/) | ✔️ | -| [Docker-Compose](https://getporter.org/mixins/docker-compose/) | ✔️ | -| [Kubernetes](https://getporter.org/mixins/kubernetes/) | ✔️ | -| [Helm](https://getporter.org/mixins/helm/) | ✔️ | -| [GCloud](https://getporter.org/mixins/gcloud/) | ✔️ | -| [Terraform](https://getporter.org/mixins/terraform/) | ✔️ | -| [aws](https://getporter.org/mixins/aws/) | ✔️ | -| [Azure](https://getporter.org/mixins/azure/) | ✔️ | -| [exec](https://getporter.org/mixins/exec/) | ✔️ | +| [Docker](https://porter.sh/mixins/docker/) | ✔️ | +| [Docker-Compose](https://porter.sh/mixins/docker-compose/) | ✔️ | +| [Kubernetes](https://porter.sh/mixins/kubernetes/) | ✔️ | +| [Helm](https://porter.sh/mixins/helm/) | ✔️ | +| [GCloud](https://porter.sh/mixins/gcloud/) | ✔️ | +| [Terraform](https://porter.sh/mixins/terraform/) | ✔️ | +| [aws](https://porter.sh/mixins/aws/) | ✔️ | +| [Azure](https://porter.sh/mixins/azure/) | ✔️ | +| [exec](https://porter.sh/mixins/exec/) | ✔️ | # Porter Plugins Plugins let you store Porter's data and retrieve secrets from an external service. -[Porter Plugins](https://getporter.org/plugins/) are available for below platform's: +[Porter Plugins](https://porter.sh/plugins/) are available for below platform's: | Platform | Supported? | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------: | -| [Hashicorp](https://getporter.org/plugins/hashicorp/) | ✔️ | -| [Azure](https://getporter.org/plugins/azure/) | ✔️ | -| [Kubernetes](https://getporter.org/plugins/kubernetes/) | ✔️ | +| [Hashicorp](https://porter.sh/plugins/hashicorp/) | ✔️ | +| [Azure](https://porter.sh/plugins/azure/) | ✔️ | +| [Kubernetes](https://porter.sh/plugins/kubernetes/) | ✔️ | # Contact @@ -55,12 +55,12 @@ Plugins let you store Porter's data and retrieve secrets from an external servic * [Slack] - We have a #porter channel and there's also #cnab for deep thoughts about the CNAB specification. -[Mailing List]: https://getporter.org/mailing-list -[Slack]: https://getporter.org/community/#slack +[Mailing List]: https://porter.sh/mailing-list +[Slack]: https://porter.sh/community/#slack [Open an Issue]: https://github.com/getporter/porter/issues/new/choose -[Forum]: https://getporter.org/forum/ -[Dev Meeting]: https://getporter.org/community/#dev-meeting -[Porter Enhancement Proposals]: https://getporter.org/docs/contribute/proposals/ +[Forum]: https://porter.sh/forum/ +[Dev Meeting]: https://porter.sh/community/#dev-meeting +[Porter Enhancement Proposals]: https://porter.sh/docs/contribute/proposals/ # Looking for Contributors @@ -68,7 +68,7 @@ Want to work on Porter with us? 💖 We are actively seeking out new contributor with the hopes of building up both casual contributors and enticing some of you into becoming reviewers and maintainers. -

Start with our New Contributors Guide +

Start with our New Contributors Guide Porter wouldn't be possible without our [contributors][contributors], carrying the load and making it better every day! 🙇‍♀️ @@ -77,7 +77,7 @@ the load and making it better every day! 🙇‍♀️ # Do you use Porter? -Take our [user survey](https://getporter.org/user-survey) and let us know if you are using Porter. +Take our [user survey](https://porter.sh/user-survey) and let us know if you are using Porter. Project funding is contingent upon knowing that we have active users! # Roadmap @@ -93,7 +93,7 @@ currently working on and plan to work on over the next few months. We use the "on-hold" bucket to communicate items of interest that do not have a maintainer who will be working on them. -

Check out our roadmap

+

Check out our roadmap

-[board]: https://getporter.org/board -[version strategy]: https://getporter.org/project/version-strategy/ +[board]: https://porter.sh/board +[version strategy]: https://porter.sh/project/version-strategy/ diff --git a/REVIEWING.md b/REVIEWING.md index 54ba8919b..3bb175ce4 100644 --- a/REVIEWING.md +++ b/REVIEWING.md @@ -117,16 +117,16 @@ of Porter. When you are asked to cut a new release, here is the process: - Include instructions for installing or upgrading to the new release: ``` # Install or Upgrade - Run (or re-run) the installation from https://getporter.org/install to get the + Run (or re-run) the installation from https://porter.sh/install to get the latest version of porter. ``` 1. Announce the new release in the community. - - Email the [mailing list](https://getporter.org/mailing-list) to announce the release. In your email, call out any breaking or notable changes. - - Post a message in [Porter's slack channel](https://getporter.org/community/#slack). + - Email the [mailing list](https://porter.sh/mailing-list) to announce the release. In your email, call out any breaking or notable changes. + - Post a message in [Porter's slack channel](https://porter.sh/community/#slack). 1. If there are any issues fixed in the release and someone is waiting for the fix, comment on the issue to let them know and link to the release. -1. If the release contains new features, it should be announced through a [blog](https://getporter.org/blog/) post and on Porter's twitter account. +1. If the release contains new features, it should be announced through a [blog](https://porter.sh/blog/) post and on Porter's twitter account. [maintainers]: https://github.com/orgs/getporter/teams/maintainers [admins]: https://github.com/orgs/getporter/teams/admins [commits]: https://github.com/getporter/porter/commits/main -[version strategy]: https://getporter.org/project/version-strategy/ +[version strategy]: https://porter.sh/project/version-strategy/ diff --git a/build/images/README.md b/build/images/README.md index 73ae10a07..a97be20dd 100644 --- a/build/images/README.md +++ b/build/images/README.md @@ -7,5 +7,5 @@ the [Porter Workshop Docker Image][workshop] documentation for examples of how to use it. -[client]: https://getporter.org/docker-images/client/ -[workshop]: https://getporter.org/docker-images/workshop/ +[client]: https://porter.sh/docker-images/client/ +[workshop]: https://porter.sh/docker-images/workshop/ diff --git a/cmd/porter/completion.go b/cmd/porter/completion.go index 4182a8afa..917a95d3f 100644 --- a/cmd/porter/completion.go +++ b/cmd/porter/completion.go @@ -11,7 +11,7 @@ func buildCompletionCommand(p *porter.Porter) *cobra.Command { Use: "completion [bash|zsh|fish|powershell]", Short: "Generate completion script", Long: `Save the output of this command to a file and load the file into your shell. -For additional details see: https://getporter.org/install#command-completion`, +For additional details see: https://porter.sh/install#command-completion`, Example: "porter completion bash > /usr/local/etc/bash_completions.d/porter", DisableFlagsInUseLine: true, ValidArgs: []string{"bash", "zsh", "fish", "powershell"}, diff --git a/cmd/porter/docs.go b/cmd/porter/docs.go index 3c9371a07..8573e1397 100644 --- a/cmd/porter/docs.go +++ b/cmd/porter/docs.go @@ -12,7 +12,7 @@ func buildDocsCommand(p *porter.Porter) *cobra.Command { cmd := &cobra.Command{ Use: "docs", Short: "Generate markdown docs", - Long: "Generate markdown docs for https://getporter.org/cli", + Long: "Generate markdown docs for https://porter.sh/cli", Hidden: true, PreRunE: func(cmd *cobra.Command, args []string) error { opts.RootCommand = cmd.Root() diff --git a/cmd/porter/installations.go b/cmd/porter/installations.go index 94105b77b..388384972 100644 --- a/cmd/porter/installations.go +++ b/cmd/porter/installations.go @@ -417,7 +417,7 @@ func addBundleActionFlags(f *pflag.FlagSet, actionOpts porter.BundleAction) { opts := actionOpts.GetOptions() addBundlePullFlags(f, &opts.BundlePullOptions) f.BoolVar(&opts.AllowDockerHostAccess, "allow-docker-host-access", false, - "Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://getporter.org/configuration/#allow-docker-host-access for the full implications of this flag.") + "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.") f.StringArrayVar(&opts.HostVolumeMounts, "mount-host-volume", nil, "Mount a host volume into the bundle. Format is :[: