From fc097dad9b8a6bf6878235d8c6ca4a2e4f411b63 Mon Sep 17 00:00:00 2001
From: Valentin Lorentz <vlorentz@softwareheritage.org>
Date: Thu, 19 Dec 2019 15:13:34 +0100
Subject: [PATCH] Update documentation of --author to use names instead of
emails.
This reflects what is done in practice and what the code expects.
Using an email is invalid because the value of --author is used
in a `http://schema.org/name` property, not `http://schema.org/email`
---
docs/getting-started.rst | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
index 5e4556b1..28345119 100644
--- a/docs/getting-started.rst
+++ b/docs/getting-started.rst
@@ -88,7 +88,8 @@ minimal deposit
.. code:: shell
$ swh deposit upload --username name --password secret \
- --author "some@nobody" --author "second@nobody" \
+ --author "Jane Doe" \
+ --author "John Doe" \
--name 'je-suis-gpl' \
--archive je-suis-gpl.tgz
@@ -97,7 +98,7 @@ with client's external identifier (``slug``)
.. code:: shell
$ swh deposit upload --username name --password secret \
- --author "some@nobody" \
+ --author "Jane Doe" \
--name 'je-suis-gpl' \
--archive je-suis-gpl.tgz \
--slug je-suis-gpl
@@ -107,7 +108,7 @@ to a specific client's collection
.. code:: shell
$ swh deposit upload --username name --password secret \
- --author "some@nobody" \
+ --author "Jane Doe" \
--name 'je-suis-gpl' \
--archive je-suis-gpl.tgz \
--collection 'second-collection'
--
GitLab