From 20b3e3e79c5dd62d65b0eafe3d968a31a05b1c31 Mon Sep 17 00:00:00 2001 From: Ralf Lang Date: Wed, 17 Aug 2022 23:24:40 +0200 Subject: [PATCH] Fix docs for issue composer/satis#656 (#11005) --- doc/articles/handling-private-packages.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/articles/handling-private-packages.md b/doc/articles/handling-private-packages.md index 3e3c93bb2..efb131e05 100644 --- a/doc/articles/handling-private-packages.md +++ b/doc/articles/handling-private-packages.md @@ -34,9 +34,11 @@ packages, or your own. You can get it from For example let's assume you have a few packages you want to reuse across your company but don't really want to open-source. You would first define a Satis -configuration: a json file with an arbitrary name that lists your curated +configuration: a json file that lists your curated [repositories](../05-repositories.md). +The default file name is satis.json but it could be anything you like. + Here is an example configuration, you see that it holds a few VCS repositories, but those could be any types of [repositories](../05-repositories.md). Then it uses `"require-all": true` which selects all versions of all packages in the @@ -46,7 +48,7 @@ The default file Satis looks for is `satis.json` in the root of the repository. ```json { - "name": "My Repository", + "name": "my/repository", "homepage": "http://packages.example.org", "repositories": [ { "type": "vcs", "url": "https://github.com/mycompany/privaterepo" }, @@ -337,4 +339,4 @@ is set to true. [ssl context options]: https://secure.php.net/manual/en/context.ssl.php [Twig]: https://twig.sensiolabs.org/ [config schema]: https://getcomposer.org/doc/04-schema.md#config -[notify-batch]: https://getcomposer.org/doc/05-repositories.md#notify-batch +[notify-batch]: https://getcomposer.org/doc/05-repositories.md#notify-batch \ No newline at end of file