From f909a7f7fb12e4c08c81ec019e9463e613b5e324 Mon Sep 17 00:00:00 2001 From: Bob den Otter Date: Fri, 7 May 2021 14:16:37 +0200 Subject: [PATCH] More docs --- couscous.yml | 4 ++-- docs/index.md | 5 ++++- docs/initial_run.md | 4 ++-- docs/troubleshooting.md | 2 +- 4 files changed, 9 insertions(+), 6 deletions(-) diff --git a/couscous.yml b/couscous.yml index d3a259c..ef90690 100644 --- a/couscous.yml +++ b/couscous.yml @@ -16,8 +16,8 @@ include: branch: gh-pages baseUrl: https://bolt.github.io/deployer -title: BoltForms -subTitle: A Bolt extension to make forms. +title: Bolt Deployer +subTitle: A Bolt recipe for Deployer. github: user: bolt repo: deployer diff --git a/docs/index.md b/docs/index.md index fc85033..725705d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,4 +25,7 @@ This documentation is split in a few parts to get you up and running: - [Regular Usage](regular_usage.html) In the sidebar on the left, you'll also find two pages with Tips and -information for Troubleshooting. \ No newline at end of file +information for Troubleshooting. + +[dep]: https://deployer.org +[bolt]: https://boltcms.io \ No newline at end of file diff --git a/docs/initial_run.md b/docs/initial_run.md index b08dfb5..efae061 100644 --- a/docs/initial_run.md +++ b/docs/initial_run.md @@ -82,8 +82,8 @@ you'll need to do the following things: the section on the "configuration" page about this topic. - Place the contents of `files/` in `shared/public/files/`. - If you're using SQLite, place the database file in `shared/var/data`. -- Apply the environment-specific configuration in `shared/.env.local` or your - `ENV` settings. +- Apply the environment-specific configuration in `shared/.env`, + `shared/.env.local` or your `ENV` settings. - Ensure both the Command-line user and the webserver's user have read/write access to the files in `shared/`. How this is done optimally, depends on how the server is configured. To just make them writable to all, use: diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 3e41034..2979bd2 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -11,7 +11,7 @@ causing the breakage. ![borken](https://user-images.githubusercontent.com/1833361/117442709-6a838b80-af37-11eb-983e-123d759320a8.png) In the screenshot above you'll notice that it breaks on `deploy:update_code`, -as indicated by the `➤` before Deployer wraps up the failed deploy. You can +as indicated by the `➤`, before Deployer wraps up the failed deploy. You can investigate by running just that step, and outputting verbose debug information: