Przeglądaj źródła

docs domain update (#4208)

Co-authored-by: sunguroku <trevor@porter.run>
sunguroku 2 lat temu
rodzic
commit
e2438dcc15

+ 1 - 1
CONTRIBUTING.md

@@ -35,7 +35,7 @@ If you want to start getting familiar with Porter's codebase, we do our best to
 
 ### Improving Documentation and Writing Tutorials
 
-Documentation is hosted at [docs.getporter.dev](https://docs.getporter.dev). To update existing documentation, you can suggest changes directly from the docs website. To create new documentation or write a tutorial, you can add a document in the `/docs` folder and make a PR directly. 
+Documentation is hosted at [docs.porter.run](https://docs.porter.run). To update existing documentation, you can suggest changes directly from the docs website. To create new documentation or write a tutorial, you can add a document in the `/docs` folder and make a PR directly. 
 
 ### Features
 

+ 2 - 2
README.md

@@ -57,6 +57,6 @@ Below are instructions for a quickstart. For full documentation, please visit ou
 
 1. Sign up and log into [Porter Dashboard](https://dashboard.getporter.dev).
 
-2. Create a Project and [put in your cloud provider credentials](https://docs.getporter.dev/docs/getting-started-with-porter-on-aws). Porter will automatically provision a Kubernetes cluster in your own cloud. It is also possible to [link up an existing Kubernetes cluster.](https://docs.getporter.dev/docs/cli-documentation#connecting-to-an-existing-cluster)
+2. Create a Project and [put in your cloud provider credentials](https://docs.porter.run/docs/getting-started-with-porter-on-aws). Porter will automatically provision a Kubernetes cluster in your own cloud. It is also possible to [link up an existing Kubernetes cluster.](https://docs.porter.run/docs/cli-documentation#connecting-to-an-existing-cluster)
 
-3. 🚀 Deploy your applications from a [git repository](https://docs.getporter.dev/docs/applications) or [Docker image registry](https://docs.getporter.dev/docs/cli-documentation#porter-docker-configure).
+3. 🚀 Deploy your applications from a [git repository](https://docs.porter.run/docs/applications) or [Docker image registry](https://docs.porter.run/docs/cli-documentation#porter-docker-configure).

+ 1 - 1
cli/cmd/commands/create.go

@@ -51,7 +51,7 @@ To modify the default configuration of the application, you can pass a values.ya
 
 To read more about the configuration options, go here:
 
-https://docs.getporter.dev/docs/deploying-from-the-cli#common-configuration-options
+https://docs.porter.run/docs/deploying-from-the-cli#common-configuration-options
 
 This command will automatically build from a local path, and will create a new Docker image in your
 default Docker registry. The path can be configured via the --path flag. For example:

+ 1 - 1
dashboard/src/main/auth/ResetPasswordFinalize.tsx

@@ -180,7 +180,7 @@ export default class ResetPasswordInit extends Component<PropsType, StateType> {
         <Footer>
           © 2021 Porter Technologies Inc. •
           <Link
-            href="https://docs.getporter.dev/docs/terms-of-service"
+            href="https://docs.porter.run/docs/terms-of-service"
             target="_blank"
           >
             Terms & Privacy

+ 1 - 1
dashboard/src/main/auth/ResetPasswordInit.tsx

@@ -122,7 +122,7 @@ export default class ResetPasswordInit extends Component<PropsType, StateType> {
         <Footer>
           © 2021 Porter Technologies Inc. •
           <Link
-            href="https://docs.getporter.dev/docs/terms-of-service"
+            href="https://docs.porter.run/docs/terms-of-service"
             target="_blank"
           >
             Terms & Privacy

+ 1 - 1
dashboard/src/main/home/NoClusterPlaceholder.tsx

@@ -54,7 +54,7 @@ class NoClusterPlaceholder extends Component<PropsType, StateType> {
         <br />
         <br />
         <br />* Required. For more information{" "}
-        <A onClick={() => window.open("https://docs.getporter.dev/docs")}>
+        <A onClick={() => window.open("https://docs.porter.run/docs")}>
           refer to our docs
         </A>
       </StyledNoClusterPlaceholder>

+ 1 - 1
dashboard/src/main/home/cluster-dashboard/dashboard/ClusterSettings.tsx

@@ -143,7 +143,7 @@ const ClusterSettings: React.FC<Props> = (props) => {
       console. Instructions to properly delete all resources can be found
       <a
         target="none"
-        href="https://docs.getporter.dev/docs/deleting-dangling-resources"
+        href="https://docs.porter.run/other/deleting-dangling-resources"
       >
         {" "}
         here

+ 2 - 2
dashboard/src/main/home/launch/expanded-template/TemplateInfo.tsx

@@ -91,7 +91,7 @@ export default class TemplateInfo extends Component<PropsType, StateType> {
             For instructions on connecting to your registry
             <Link
               target="_blank"
-              href="https://docs.getporter.dev/docs/cli-documentation#pushing-docker-images-to-your-porter-image-registry"
+              href="https://docs.porter.run/docs/cli-documentation#pushing-docker-images-to-your-porter-image-registry"
             >
               refer to our docs
             </Link>
@@ -110,7 +110,7 @@ export default class TemplateInfo extends Component<PropsType, StateType> {
             To use this template you must first follow
             <Link
               target="_blank"
-              href="https://docs.getporter.dev/docs/https-and-custom-domains"
+              href="https://docs.porter.run/docs/https-and-custom-domains"
             >
               Porter's HTTPS setup guide
             </Link>

+ 2 - 2
docs/deploy/addons/strapi.md

@@ -11,7 +11,7 @@ This is a quick guide on how to deploy Strapi to a Kubernetes cluster in AWS/GCP
 6. Hit Deploy!
 
 ## Deploying PostgresDB
-1. Strapi instance deployed through Porter connects to PostgresDB. You can connect Strapi instance deployed on Porter to any external database, but it is also possible to use a database that is also deployed on Porter. Follow [this guide to deploy a PostgresDB instance to your cluster in one click](https://docs.getporter.dev/docs/postgresdb).
+1. Strapi instance deployed through Porter connects to PostgresDB. You can connect Strapi instance deployed on Porter to any external database, but it is also possible to use a database that is also deployed on Porter. Follow [this guide to deploy a PostgresDB instance to your cluster in one click](https://docs.porter.run/docs/postgresdb).
 2. After the database has been deployed, navigate to the **Environment variables** tab of your deployed Strapi instance. Configure the following environment variables:
 ```
 NODE_ENV=production
@@ -21,7 +21,7 @@ DATABASE_NAME=
 DATABASE_USERNAME=
 DATABASE_PASSWORD=
 ```
-To determine what the correct environment variables are in order to connect to the deployed database, [see this guide](https://docs.getporter.dev/docs/postgresdb#connecting-to-the-database).
+To determine what the correct environment variables are in order to connect to the deployed database, [see this guide](https://docs.porter.run/docs/postgresdb#connecting-to-the-database).
 
 # Development
 To develop, clone the [example repository](https://github.com/porter-dev/strapi) to your local environment and run `npm install && npm run develop;` from the `app` directory. Porter will automatically handle CI/CD and propagate your changes to production on every push to the repository.

+ 1 - 1
docs/deploy/applications/deploying-django-application-non-docker.md

@@ -4,7 +4,7 @@ To deploy your Django Application in Porter. You need to tweak something on your
 
 > 📘 Prerequisites
 > - Django Application
-> - Docker Registry integration on your account ([See docs](https://docs.getporter.dev/docs/linking-an-existing-docker-container-registry))
+> - Docker Registry integration on your account ([See docs](https://docs.porter.run/docs/linking-an-existing-docker-container-registry))
 
 
 ## Prepare Django Application

+ 2 - 2
docs/deploy/applications/deploying-from-docker-registry.md

@@ -2,7 +2,7 @@ Porter lets you deploy a service from a public or private Docker image registry.
 
 > 📘 Prerequisites
 >
-> - A public Docker image or private container registry linked to Porter. See how to [link a registry to Porter]((https://docs.getporter.dev/docs/linking-an-existing-docker-container-registry))
+> - A public Docker image or private container registry linked to Porter. See how to [link a registry to Porter]((https://docs.porter.run/docs/linking-an-existing-docker-container-registry))
 > - A Kubernetes cluster connected to Porter (linked by default if you provisioned through Porter). 
 >
 > **Note:** If you didn't provision through Porter, you can still [link an existing cluster](). 
@@ -11,7 +11,7 @@ Let's get started!
 
 1. On the Porter dashboard, navigate to the **Launch** tab in the sidebar and select **Web Service** -> **Launch Template**.
 
-2. Select the **Docker Registry** option. If you have not linked a registry, you can do so from the **Integrations** tab ([learn more](https://docs.getporter.dev/docs/linking-an-existing-docker-container-registry)). 
+2. Select the **Docker Registry** option. If you have not linked a registry, you can do so from the **Integrations** tab ([learn more](https://docs.porter.run/docs/linking-an-existing-docker-container-registry)). 
 
 3. Indicate the image repo and image tag you would like to use.
 

+ 2 - 2
docs/deploy/applications/deploying-from-git-repo.md

@@ -14,7 +14,7 @@ Let's get started!
 
 > 📘
 > 
-> Porter will set up CI/CD with [Github Actions](https://github.com/features/actions) to automatically build and deploy new versions of your code. You can learn more about how Porter uses Github Actions [here](https://docs.getporter.dev/docs/auto-deploy-requirements#cicd-with-github-actions).
+> Porter will set up CI/CD with [Github Actions](https://github.com/features/actions) to automatically build and deploy new versions of your code. You can learn more about how Porter uses Github Actions [here](https://docs.porter.run/docs/auto-deploy-requirements#cicd-with-github-actions).
 
 ![Select Repository](https://files.readme.io/0660e91-Screen_Shot_2021-03-17_at_7.20.44_PM.png "Screen Shot 2021-03-17 at 7.20.44 PM.png")
 
@@ -22,7 +22,7 @@ Let's get started!
 
 > 📘
 > 
-> If you specify a folder in your repo to use as source, Porter will autodetect the language runtime and build your application using Cloud Native Buildpacks. For more details refer to our guide on [requirements for auto build](https://docs.getporter.dev/docs/auto-deploy-requirements).
+> If you specify a folder in your repo to use as source, Porter will autodetect the language runtime and build your application using Cloud Native Buildpacks. For more details refer to our guide on [requirements for auto build](https://docs.porter.run/docs/auto-deploy-requirements).
 
 4. Click **Continue** once your source has been connected. This will take you to the **GitHub Actions** page, where you can see a workflow that will be created in the selected repository for automatically deploying new changes as they are pushed.  
 You can skip the creation of this workflow using the **Create workflow file** toggle, in case you wish to manually add the [`porter-update-action`](https://github.com/porter-dev/porter-update-action) to a different workflow of your choice.  

+ 2 - 2
docs/deploy/applications/deploying-from-the-cli.md

@@ -39,7 +39,7 @@ The default behavior of `porter create` is to use the local filesystem to build,
 porter create web --app web-test
 ```
 
-Porter will look for a `Dockerfile` located at the root of the current directory. If a `Dockerfile` is found, Porter will use the default Docker container registry linked to the Porter project to deploy the application. If a `Dockerfile` is not found, Porter will use a [Cloud-Native Buildpack](https://docs.getporter.dev/docs/auto-deploy-requirements#auto-build-with-cloud-native-buildpacks) to build your application. 
+Porter will look for a `Dockerfile` located at the root of the current directory. If a `Dockerfile` is found, Porter will use the default Docker container registry linked to the Porter project to deploy the application. If a `Dockerfile` is not found, Porter will use a [Cloud-Native Buildpack](https://docs.porter.run/docs/auto-deploy-requirements#auto-build-with-cloud-native-buildpacks) to build your application. 
 
 To point to a Dockerfile, you should pass the **relative path** to the Dockerfile from the root directory of the source code:
 
@@ -65,7 +65,7 @@ If your local branch is set to track changes from an upstream remote branch, Por
 
 ## Deploying from a Docker Registry 
 
-The CLI also supports deploying directly from a Docker image which is hosted on a [connected Docker registry](https://docs.getporter.dev/docs/linking-an-existing-docker-container-registry). Simply specify `--source registry` and the application image via the `--image` tag:
+The CLI also supports deploying directly from a Docker image which is hosted on a [connected Docker registry](https://docs.porter.run/docs/linking-an-existing-docker-container-registry). Simply specify `--source registry` and the application image via the `--image` tag:
 
 ```sh
 porter create web --app web-test --source registry --image gcr.io/snowflake-12345/web-test:latest

+ 1 - 1
docs/guides/advanced-nginx-settings.md

@@ -1,6 +1,6 @@
 > 🚧
 >
-> **Note:** these advanced configuration will only work if you've set up a [custom domain](https://docs.getporter.dev/docs/https-and-custom-domains). They will not work on `*.porter.run` domains. 
+> **Note:** these advanced configuration will only work if you've set up a [custom domain](https://docs.porter.run/docs/https-and-custom-domains). They will not work on `*.porter.run` domains. 
 
 Every cluster provisioned by Porter by default uses an NGINX [ingress controller](https://kubernetes.github.io/ingress-nginx) to connect your web applications to the internet. There are different options for customizing the NGINX configuration that a specific application uses. 
 

+ 3 - 3
docs/guides/jobs-and-cron-jobs.md

@@ -1,11 +1,11 @@
-You can create one-time jobs or cron jobs on Porter, which can be linked [from your Github repo](https://docs.getporter.dev/docs/applications) or [from an existing Docker image registry](https://docs.getporter.dev/docs/deploying-from-docker-image-registry). Cron jobs are meant to run on a schedule using a specified [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression), while one-time jobs are meant to be triggered manually. Here are some use-cases for each type of job:
+You can create one-time jobs or cron jobs on Porter, which can be linked [from your Github repo](https://docs.porter.run/docs/applications) or [from an existing Docker image registry](https://docs.porter.run/docs/deploying-from-docker-image-registry). Cron jobs are meant to run on a schedule using a specified [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression), while one-time jobs are meant to be triggered manually. Here are some use-cases for each type of job:
 
 - Run one-time jobs for database migration scripts, data processing, or generally scripts that are designed to run to completion on an unpredictable schedule
 - Run cron jobs for tasks that should run on a specified schedule, such as scraping data at a specified interval, cleaning up rows in a database, taking backups of a DB, or sending batch notifications at a specified time every day
 
 # Deploying a One-Time Job
 
-To deploy a one-time job on Porter, head to the "Launch" tab and select the "Jobs" template. From this template, you can connect your source ([Github repo](https://docs.getporter.dev/docs/applications) or [Docker image registry](https://docs.getporter.dev/docs/deploying-from-docker-image-registry)), specify the job command, and add environment variables. For example, to create a job that simply prints to the console from an environment variable, we can create a job with the following configuration:
+To deploy a one-time job on Porter, head to the "Launch" tab and select the "Jobs" template. From this template, you can connect your source ([Github repo](https://docs.porter.run/docs/applications) or [Docker image registry](https://docs.porter.run/docs/deploying-from-docker-image-registry)), specify the job command, and add environment variables. For example, to create a job that simply prints to the console from an environment variable, we can create a job with the following configuration:
 
 ![One-time job](https://files.readme.io/f566850-Screen_Shot_2021-04-16_at_2.54.35_PM.png "Screen Shot 2021-04-16 at 2.54.35 PM.png")
 
@@ -19,7 +19,7 @@ To re-run the job, simply click the "Rerun job" button in the bottom right corne
 
 > 📘
 >
-> **Note:** as an alternative to one-time jobs, you can also run a command using [remote execution](https://docs.getporter.dev/docs/cli-documentation#remote-execution) from the CLI. This is simpler to do, but lacks the benefit of getting the history of jobs along with logs and status for each job.
+> **Note:** as an alternative to one-time jobs, you can also run a command using [remote execution](https://docs.porter.run/docs/cli-documentation#remote-execution) from the CLI. This is simpler to do, but lacks the benefit of getting the history of jobs along with logs and status for each job.
 
 ## Running One-Time Jobs from Github Repositories
 

+ 1 - 1
docs/guides/running-porter-locally.md

@@ -4,7 +4,7 @@ While it requires a few additional steps, it is possible to run Porter locally.
 
 To run the Porter binary, follow these steps: 
 
-1. [Install our CLI](https://docs.getporter.dev/docs/cli-documentation#installation)
+1. [Install our CLI](https://docs.porter.run/docs/cli-documentation#installation)
 
 2. Run `porter server start`. This will spin up a local Porter instance on port 8080.
 

+ 1 - 1
docs/guides/template-versioning-and-upgrades.md

@@ -1,7 +1,7 @@
 
 > 📘
 >
-> **Note:** this functionality was introduced in [Porter release 0.3.0](https://docs.getporter.dev/changelog/v030-tuesday-18-may-2021). By default, all charts deployed before this release were versioned with `v0.1.0`. If you experience any issues upgrading from `v0.1.0`, it is recommended that you **re-deploy the service with the latest version from the Launch tab**.
+> **Note:** this functionality was introduced in [Porter release 0.3.0](https://docs.porter.run/changelog/v030-tuesday-18-may-2021). By default, all charts deployed before this release were versioned with `v0.1.0`. If you experience any issues upgrading from `v0.1.0`, it is recommended that you **re-deploy the service with the latest version from the Launch tab**.
 
 
 # Deploying a Specific Template Version

+ 1 - 1
services/deploy_init_container/start.sh

@@ -12,7 +12,7 @@ select the Actions tab.
 -------------------------------------------------------------------
 -------------------------------------------------------------------
 For more information, visit:
-https://docs.getporter.dev/docs/setting-up-cicd-1
+https://docs.porter.run/docs/setting-up-cicd-1
 -------------------------------------------------------------------
 EOF
 

+ 1 - 1
services/deploy_job_init_container/start.sh

@@ -12,6 +12,6 @@ select the Actions tab.
 -------------------------------------------------------------------
 -------------------------------------------------------------------
 For more information, visit:
-https://docs.getporter.dev/docs/setting-up-cicd-1
+https://docs.porter.run/docs/setting-up-cicd-1
 -------------------------------------------------------------------
 EOF