Skip to content

Commit

Permalink
Update faq.md, some wording tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
emdoyle committed Apr 16, 2024
1 parent feed927 commit 2bfd629
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Setting up service bridge_celery...
[12:00:00] ✓ Local worker started
Service bridge_celery started!
Setting up service bridge_flower...
[00:02:52] ✓ Flower started
[12:00:00] ✓ Flower started
Service bridge_flower started!
Performing system checks...

Expand Down
6 changes: 4 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ When running locally, Bridge uses Docker to create and manage containers for Pos

### How does it work with deployments?

When you are ready to deploy, Bridge creates configuration files for Render that specify how to build and run your Django application alongside the same services. Bridge also writes a "Deploy to Render" button straight into your README for added convenience!
When you are ready to deploy, Bridge creates configuration files for Render that specify how to build and run your Django application alongside the same services. Bridge also writes a "Deploy to Render" button straight into your README for added convenience! You can deploy your application by clicking the 'Deploy to Render' button shown on your project's GitHub page.

### What if I don't need all the services that bridge provides?
- [for evan to fill out]

Bridge is designed to be modular. You can configure only the services you need by creating or editing the `bridge.yaml` file that Bridge creates in your project root. By default, `enable_postgres: true` and `enable_worker: true` are set, but you can change these to `false` to prevent bridge from configuring Postgres and Celery respectively.


### How can I stop the services that bridge spins up?
`bridge stop` will stop all running services.
Expand Down
3 changes: 3 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Client: ...
```

## Installation
Install bridge from PyPI:
```bash
pip install python-bridge
```
Expand Down Expand Up @@ -60,7 +61,9 @@ Bridge can also handle deployed configuration for your app as well! Simply run:
bridge init render
```
You may be prompted for the entrypoint of your application and settings file if bridge cannot detect them.

Bridge will create all the configuration necessary for you to immediately deploy to [Render](https://render.com/). This includes a Blueprint `render.yaml` as well as build scripts and start scripts for your Django application.

After running `bridge init render`, commit the changes and visit your project on github. You will see the following button at the end of your README in the root of your repository:

![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)
Expand Down

0 comments on commit 2bfd629

Please sign in to comment.