From 972b356302e4e802a98ebb050ee874a5b82292a3 Mon Sep 17 00:00:00 2001 From: Kumaran Rajendhiran Date: Wed, 20 Nov 2024 09:34:45 +0000 Subject: [PATCH] Remove preferred word --- README.md | 4 +++- docs/docs/en/user-guide/getting-started/index.md | 8 +++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5e9e079c..f75c4c6d 100644 --- a/README.md +++ b/README.md @@ -288,7 +288,9 @@ Once you have reserved your application name, you can test whether you can deplo ./scripts/deploy_to_fly_io.sh ``` -The preferred way to deploy your application to Fly.io is by using [**GitHub Actions**](https://github.com/features/actions). Simply push your code to your github repository's **main** branch and GitHub Actions will automatically deploy your application to Fly.io. For this, you need to set the following secrets in your GitHub repository: +This is only for testing purposes. You should deploy using [**GitHub Actions**](https://github.com/features/actions){target="_blank"} as explained below. + +Cookiecutter generated all the necessary files to deploy your application to Fly.io using [**GitHub Actions**](https://github.com/features/actions). Simply push your code to your github repository's **main** branch and GitHub Actions will automatically deploy your application to Fly.io. For this, you need to set the following secrets in your GitHub repository: - `FLY_API_TOKEN` - `OPENAI_API_KEY` diff --git a/docs/docs/en/user-guide/getting-started/index.md b/docs/docs/en/user-guide/getting-started/index.md index 61120754..90134a6e 100644 --- a/docs/docs/en/user-guide/getting-started/index.md +++ b/docs/docs/en/user-guide/getting-started/index.md @@ -486,11 +486,12 @@ This script will deploy your application to Fly.io without any further input. Th ``` -The preferred way to deploy the FastAgency application to Fly.io is by using [**GitHub Actions**](https://github.com/features/actions){target="_blank"} which is explained in the next section. + +This is only for testing purposes. You should deploy using [**GitHub Actions**](https://github.com/features/actions){target="_blank"} as explained in the next section. #### Deploying to Fly.io using GitHub Actions -The preferred way to deploy your application to Fly.io is by using [**GitHub Actions**](https://github.com/features/actions){target="_blank"}. You can deploy using Github Actions by following these steps: +Cookiecutter generated all the necessary files to deploy your application to Fly.io using [**GitHub Actions**](https://github.com/features/actions){target="_blank"}. Github Actions deployment worfkow will not work unless you follow these steps: 1. Create a [**new GitHub repository**](https://github.com/new){target="_blank"} with your FastAgency project name. @@ -519,6 +520,3 @@ The preferred way to deploy your application to Fly.io is by using [**GitHub Act Make sure to replace `` and `` with your GitHub username and repository name, respectively. Once these steps are complete, the GitHub Actions workflow will automatically deploy your application to Fly.io. And continue to do so every time you push changes to your repository's **main** branch. - -!!! danger - If you skip these steps, the GitHub Actions workflow will **fail** when changes are pushed to the repository's **main** branch.