mirror of
https://github.com/TheLocehiliosan/yadm
synced 2024-10-27 20:34:27 +00:00
[Contributing-docs] Add the COMPOSE_V2 switch
Linked to PR #433 Update the contributing docs to expose COMPOSE_V2 Signed-off-by: Nicolas signed-log FORMICHELLA <stigpro@outlook.fr>
This commit is contained in:
parent
36fda72bec
commit
3e98984224
4
.github/CONTRIBUTING.md
vendored
4
.github/CONTRIBUTING.md
vendored
@ -328,6 +328,9 @@ produce a help page.
|
|||||||
* `make clean`:
|
* `make clean`:
|
||||||
Remove previously built data any any Jekyll containers.
|
Remove previously built data any any Jekyll containers.
|
||||||
|
|
||||||
|
Please note that the Makefile will by default, for backwards-compatibility reasons, use the Python `docker-compose` (v1) and not the *new* integrated version ([v2][compose-v2]).
|
||||||
|
To use the newer version instead of the legacy one, add `COMPOSE_V2=1` at the end of the `make` command.
|
||||||
|
|
||||||
When making website changes, be sure to adhere to [code](#code-conventions) and
|
When making website changes, be sure to adhere to [code](#code-conventions) and
|
||||||
[commit](#commit-conventions) conventions. Use the same [GitHub
|
[commit](#commit-conventions) conventions. Use the same [GitHub
|
||||||
workflow](#github-workflow) when creating a pull request. However use the
|
workflow](#github-workflow) when creating a pull request. However use the
|
||||||
@ -362,6 +365,7 @@ see if you can help.
|
|||||||
[commit-style]: https://chris.beams.io/posts/git-commit/#seven-rules
|
[commit-style]: https://chris.beams.io/posts/git-commit/#seven-rules
|
||||||
[conduct]: CODE_OF_CONDUCT.md
|
[conduct]: CODE_OF_CONDUCT.md
|
||||||
[contrib-hooks]: https://github.com/TheLocehiliosan/yadm/tree/master/contrib/hooks
|
[contrib-hooks]: https://github.com/TheLocehiliosan/yadm/tree/master/contrib/hooks
|
||||||
|
[compose-v2]: https://docs.docker.com/compose/#compose-v2-and-the-new-docker-compose-command
|
||||||
[flake8]: https://pypi.org/project/flake8/
|
[flake8]: https://pypi.org/project/flake8/
|
||||||
[groff-man]: https://www.gnu.org/software/groff/manual/html_node/man.html
|
[groff-man]: https://www.gnu.org/software/groff/manual/html_node/man.html
|
||||||
[hooks-help]: https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#hooks
|
[hooks-help]: https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#hooks
|
||||||
|
Loading…
Reference in New Issue
Block a user