diff --git a/docs/config.md b/docs/config.md index f6e55a5..c9e9dfd 100644 --- a/docs/config.md +++ b/docs/config.md @@ -33,7 +33,7 @@ Note that if the above config options are not enough, all Lando recipes can be f ## Choosing a php version -You can set `php` to any version that is available in our [php service](https://docs.lando.dev/php). However, you should consult the [Backdrop requirements](https://backdropcms.org/requirements) to make sure that version is actually supported by Backdrop itself. +You can set `php` to any version that is available in our [php service](https://docs.lando.dev/php). However, you should consult the [Backdrop requirements](https://docs.backdropcms.org/documentation/system-requirements) to make sure that version is actually supported by Backdrop itself. The [recipe config](https://docs.lando.dev/core/v3/recipes.html#config) to set the Backdrop recipe to use `php` version `5.5` is shown below: @@ -107,7 +107,7 @@ config: ## Connecting to your database -Unlike other unnamed php-based CMSes, Backdrop's database connection information can be set by an environmental variable named [`BACKDROP_SETTINGS`](https://api.backdropcms.org/api/backdrop/core%21includes%21bootstrap.inc/function/backdrop_settings_initialize/1). Lando will set this variable for you which means that unless you explicitly hijack the default functionality, *you should not need to do anything* to configure your database connection. +Unlike other unnamed php-based CMSes, Backdrop's database connection information can be set by an environmental variable named [`BACKDROP_SETTINGS`](https://docs.backdropcms.org/api/backdrop/core%21includes%21bootstrap.inc/function/backdrop_settings_initialize/1). Lando will set this variable for you which means that unless you explicitly hijack the default functionality, *you should not need to do anything* to configure your database connection. You can also examine and use this variable in-code similarly to how you would with [`LANDO_INFO`](https://docs.lando.dev/guides/lando-info.html). @@ -131,7 +131,7 @@ You can get also get the above information, and more, by using the [`lando info` ## Using custom config files -You may need to override our [default Backdrop config](https://github.com/lando/backdrop/tree/main/recipes/backdrop) with your own. +You may need to override our [default Backdrop config](https://github.com/lando/backdrop/tree/main/builders/backdrop.js) with your own. If you do this, you must use files that exist inside your application and express them relative to your project root as shown below: diff --git a/docs/development.md b/docs/development.md index 9ac06f1..7b5b6eb 100644 --- a/docs/development.md +++ b/docs/development.md @@ -19,7 +19,7 @@ At the very least you will need to have the following installed: ```sh # Clone this repo -git clone https://github.com/lando/backdrop.git && cd backdrop +git clone https://github.com/lando/backdrop && cd backdrop # Install deps npm install @@ -162,4 +162,3 @@ npm install @lando/backdrop@edge ## Contribution -If you want to contribute code then just follow [this flow](https://docs.github.com/en/get-started/using-github/github-flow). \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started.md index 5764d70..c2b6fe2 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -9,7 +9,7 @@ description: Learn how to get started with the Lando Backdrop recipe. Before you get started with this recipe we assume that you have: 1. [Installed Lando](https://docs.lando.dev/getting-started/installation.html) and gotten familiar with [its basics](https://docs.lando.dev/cli/) -2. [Initialized](https://docs.lando.dev/getting-started/init.html) a [Landofile](https://docs.lando.dev/core/v3) for your codebase for use with this recipe +2. [Initialized](https://docs.lando.dev/cli/init.html) a [Landofile](https://docs.lando.dev/core/v3) for your codebase for use with this recipe 3. Read about the various [services](https://docs.lando.dev/core/v3/lando-service.html), [tooling](https://docs.lando.dev/core/v3/tooling.html), [events](https://docs.lando.dev/core/v3/events.html) and [routing](https://docs.lando.dev/core/v3/proxy.html) Lando offers. ## Quick Start @@ -23,7 +23,7 @@ mkdir backdrop && cd backdrop # Initialize a backdrop recipe using the latest backdrop version lando init \ --source remote \ - --remote-url https://github.com/backdrop/backdrop/releases/latest/download/backdrop.zip \ + --remote-url https://objects.githubusercontent.com/github-production-release-asset-2e65be/12285928/c6a129e8-867d-45b3-a307-c46e22076739?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240201%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240201T224039Z&X-Amz-Expires=300&X-Amz-Signature=9edb500048b3a1bddb9f26468aa97a4fdb85951e90232de6f590231752dfcb52&X-Amz-SignedHeaders=host&actor_id=0&key_id=0&repo_id=12285928&response-content-disposition=attachment%3B%20filename%3Dbackdrop.zip&response-content-type=application%2Foctet-stream \ --recipe backdrop \ --webroot backdrop \ --name my-first-backdrop-app @@ -42,44 +42,3 @@ lando bee site-install lando bee uli ``` -## Custom Installation - -This plugin is included with Lando by default. That means if you have Lando version `3.0.8` or higher then this plugin is already installed! - -However if you would like to manually install the plugin, update it to the bleeding edge or install a particular version then use the below. Note that this installation method requires Lando `3.5.0+`. - -:::: code-group -::: code-group-item LANDO 3.21+ -```bash:no-line-numbers -lando plugin-add @lando/backdrop -``` -::: -::: code-group-item HYPERDRIVE -```bash:no-line-numbers -# @TODO -# @NOTE: This doesn't actaully work yet -hyperdrive install @lando/backdrop -``` -::: -::: code-group-item DOCKER -```bash:no-line-numbers -# Ensure you have a global plugins directory -mkdir -p ~/.lando/plugins - -# Install plugin -# NOTE: Modify the "npm install @lando/backdrop" line to install a particular version eg -# npm install @lando/platform@0.5.2 -docker run --rm -it -v ${HOME}/.lando/plugins:/plugins -w /tmp node:14-alpine sh -c \ - "npm init -y \ - && npm install @lando/backdrop --production --flat --no-default-rc --no-lockfile --link-duplicates \ - && npm install --production --cwd /tmp/node_modules/@lando/backdrop \ - && mkdir -p /plugins/@lando \ - && mv --force /tmp/node_modules/@lando/backdrop /plugins/@lando/backdrop" - -# Rebuild the plugin cache -lando --clear -``` -::: -:::: - -You should be able to verify the plugin is installed by running `lando config --path plugins` and checking for `@lando/backdrop`. This command will also show you _where_ the plugin is being loaded from.