Skip to content

Commit 2438776

Browse files
committed
Update documentation format for new builder
1 parent 5452cf4 commit 2438776

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

configuration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Configuration
1+
# Configuration
22

33
```{toctree}
44
---

environments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Environments
1+
# Environments
22

33
```{toctree}
44
---

environments/magento2.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The below example demonstrates the from-scratch setup of the Magento 2 application for local development. A similar process can easily be used to configure an environment of any other type. This assumes that Warden has been previously started via `warden svc up` as part of the installation procedure.
44

5-
```note::
5+
```{note}
66
In addition to the below manual process, there is a `Github Template available for Magento 2 <https://github.com/wardenenv/warden-env-magento2>`_ allowing for quick setup of new Magento projects. To use this, click the green "Use this template" button to create your own repository based on the template repository, run the init script and update the README with any project specific information.
77
```
88

@@ -64,7 +64,7 @@ The below example demonstrates the from-scratch setup of the Magento 2 applicati
6464

6565
warden env up
6666

67-
```warning::
67+
```{warning}
6868
If you encounter an error about ``Mounts denied``, follow the instructions in the error message and run ``warden env up`` again.
6969
```
7070
@@ -76,7 +76,7 @@ The below example demonstrates the from-scratch setup of the Magento 2 applicati
7676
7777
composer global config http-basic.repo.magento.com <username> <password>
7878
79-
```note::
79+
```{note}
8080
To locate your authentication keys for Magento 2 repository, `reference DevDocs <https://devdocs.magento.com/guides/v2.3/install-gde/prereq/connect-auth.html>`_.
8181
8282
If you have previously configured global credentials, you may skip this step, as ``~/.composer/`` is mounted into the container from the host machine in order to share composer cache between projects, and also shares the global ``auth.json`` from the host machine.
@@ -154,7 +154,7 @@ The below example demonstrates the from-scratch setup of the Magento 2 applicati
154154
bin/magento indexer:reindex
155155
bin/magento cache:flush
156156
157-
```note::
157+
```{note}
158158
Prior to Magento ``2.4.x`` it was not required to enter search-engine and elasticsearch configuration during installation and these params to ``setup:install`` are not supported by Magento ``2.3.x``. These should be omitted on older versions where not supported and Elasticsearch configured via ``config:set`` instead:
159159
160160
.. code::
@@ -197,7 +197,7 @@ The below example demonstrates the from-scratch setup of the Magento 2 applicati
197197
segno "${OTPAUTH_URL}" -s 4 -o "pub/media/${ADMIN_USER}-totp-qr.png"
198198
printf "%s\n\n" "https://${TRAEFIK_SUBDOMAIN}.${TRAEFIK_DOMAIN}/media/${ADMIN_USER}-totp-qr.png?t=$(date +%s)"
199199
200-
```note::
200+
```{note}
201201
Use of 2FA is mandatory on Magento ``2.4.x`` and setup of 2FA should be skipped when installing ``2.3.x`` or earlier. Where 2FA is setup manually via UI upon login rather than using the CLI commands above, the 2FA configuration email may be retrieved from `the Mailhog service <https://mailhog.warden.test/>`_.
202202
```
203203
@@ -208,6 +208,6 @@ The below example demonstrates the from-scratch setup of the Magento 2 applicati
208208
- [https://rabbitmq.exampleproject.test/](https://rabbitmq.exampleproject.test/)
209209
- [https://elasticsearch.exampleproject.test/](https://elasticsearch.exampleproject.test/)
210210
211-
```note::
211+
```{note}
212212
To completely destroy the ``exampleproject`` environment we just created, run ``warden env down -v`` to tear down the project's Docker containers, volumes, etc.
213213
```

environments/shopware.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The below example demonstrates the from-scratch setup of the Shopware 6 applicat
5151

5252
warden env up
5353

54-
```warning::
54+
```{warning}
5555
If you encounter an error about ``Mounts denied``, follow the instructions in the error message and run ``warden env up`` again.
5656
```
5757
@@ -72,10 +72,10 @@ The below example demonstrates the from-scratch setup of the Shopware 6 applicat
7272
- [https://app.exampleproject.test/](https://app.exampleproject.test/)
7373
- [https://app.exampleproject.test/admin/](https://app.exampleproject.test/admin/)
7474
75-
```note::
75+
```{note}
7676
The default username for Shopware 6 is ``admin`` with password ``shopware``.
7777
```
7878

79-
```note::
79+
```{note}
8080
To completely destroy the ``exampleproject`` environment we just created, run ``warden env down -v`` to tear down the project's Docker containers, volumes, etc.
8181
```

images.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
## Docker Images
1+
# Docker Images
22

33
Each of the docker images used by Warden environments are published on Docker Hub: [https://hub.docker.com/u/wardenenv](https://hub.docker.com/u/wardenenv). Source files used to build these images may be found in the `images` directory of the main project repository. Github Actions are used to automatically build and push new images to Docker Hub when image sources are modified. Please refer to the repositories on Docker Hub for a list of available image versions and tags.

0 commit comments

Comments
 (0)