Skip to content

Commit

Permalink
Fix some missing info in docs, fix mkdocs config
Browse files Browse the repository at this point in the history
  • Loading branch information
emdoyle committed Apr 16, 2024
1 parent 947ff8b commit 0dd26a0
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Fully automate your local and deployed infrastructure.

![](https://raw.githubusercontent.com/Never-Over/bridge/main/docs/runserver_demo.gif)

[Docs](https://never-over.github.io/bridge/)
[Full Documentation](https://never-over.github.io/bridge/)

### What is bridge?
Bridge enables you to seamlessly run and deploy all the infrastructure you need for a complete Django project.
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Locally, bridge provides access to a psql shell through `bridge db shell`. Remot
Bridge provides access to redis-cli through `bridge redis shell`. Remotely, [Render has instructions for connecting](https://docs.render.com/redis#connecting-using-redis-cli).

### How can I access Celery?
Flower is a web interface into all the information you need to debug and work with Celery. By default, bridge will run Flower on http://localhost:5000.
Flower is a web interface into all the information you need to debug and work with Celery. By default, bridge will run Flower on http://localhost:5555.
10 changes: 6 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Adding bridge to your project is incredibly simple.

Add the following code to the end of your `settings.py` file (or `DJANGO_SETTINGS_MODULE`):
```python
# Configure infrastructure with Bridge. All other settings should be above this line.
# Configure infrastructure with Bridge.
# All other settings should be above these lines.
from bridge.django import configure

configure(locals())
Expand All @@ -45,7 +46,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 All @@ -72,8 +73,9 @@ To deploy your application to the world, simply click the button! Bridge will co

In the future, we'll look into supporting more deployment runtimes such as Heroku, AWS, GCP, Azure, and more.

> [!IMPORTANT]
> Bridge currently assumes assumptions about your project structure as outlined below. If your project does not follow these conventions, you may need to adjust the generated files before deploying.
!!! note

Bridge currently assumes assumptions about your project structure as outlined below. If your project does not follow these conventions, you may need to adjust the generated files before deploying.

### Project Structure

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Automate your local and deployed infra in one line.

#todo add gif
![](https://raw.githubusercontent.com/Never-Over/bridge/main/docs/runserver_demo.gif)


## What is bridge?
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ repo_name: bridge
repo_url: https://github.com/Never-Over/bridge
nav:
- index.md
- getting-started.md
- faq.md
theme:
palette:
Expand Down Expand Up @@ -47,6 +48,8 @@ markdown_extensions:
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- admonition
extra:
social:
- icon: fontawesome/solid/envelope
Expand Down

0 comments on commit 0dd26a0

Please sign in to comment.