0ct0pu5/yadm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Contributing-docs] Add the COMPOSE_V2 switch

Browse source 
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:
Nicolas signed-log FORMICHELLA 2022-08-28 19:28:42 +02:00
parent 36fda72bec
commit 3e98984224
No known key found for this signature in database
GPG key ID: 273140E170D76BA6
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/CONTRIBUTING.md vendored
View file

@ -328,6 +328,9 @@ produce a help page.
* `make clean`:
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
[commit](#commit-conventions) conventions. Use the same [GitHub
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
[conduct]: CODE_OF_CONDUCT.md
[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/
[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