From 0dd26a02c035fd049609bc15543d509825abf7ba Mon Sep 17 00:00:00 2001 From: Evan Doyle Date: Mon, 15 Apr 2024 22:19:39 -0700 Subject: [PATCH] Fix some missing info in docs, fix mkdocs config --- README.md | 2 +- docs/faq.md | 2 +- docs/getting-started.md | 10 ++++++---- docs/index.md | 2 +- mkdocs.yml | 3 +++ 5 files changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ecd9d37..ef096ff 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/faq.md b/docs/faq.md index b26efe6..84e2a87 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -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. diff --git a/docs/getting-started.md b/docs/getting-started.md index d43f5d6..8e47348 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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()) @@ -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... @@ -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 diff --git a/docs/index.md b/docs/index.md index 7da3f25..3836a19 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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? diff --git a/mkdocs.yml b/mkdocs.yml index c6143e8..adc1110 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: @@ -47,6 +48,8 @@ markdown_extensions: - pymdownx.inlinehilite - pymdownx.snippets - pymdownx.superfences + - pymdownx.details + - admonition extra: social: - icon: fontawesome/solid/envelope