Skip to content

Commit fb81d92

Browse files
Fix d2d docs: correct flags, args order, examples
Signed-off-by: Muhammad Abdullah Shahid <108458621+abdollahShahid@users.noreply.github.com>
1 parent 3ddf53e commit fb81d92

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

docs/d2d-options.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Usage
1717

1818
.. code-block:: bash
1919
20-
./map-deploy-to-develop.sh <from-path> <to-path> <output-file> [--options <value>] [--spin-db] [--port <db-port>]
21-
20+
./map-deploy-to-develop.sh <from-path> <to-path> <output-file> \
21+
[--options <value>] [--spin-db] [--db-port <port>]
2222
2323
Arguments
2424
---------
@@ -38,11 +38,10 @@ Arguments
3838
| ``--spin-db`` | Optional flag to start a temporary PostgreSQL DB container |
3939
| | (omit the flag to skip starting the DB). |
4040
+-----------------+---------------------------------------------------------------------+
41-
| ``--port`` | Optional flag to specify the Postgres bind port |
41+
| ``--db-port`` | Optional flag to specify the Postgres bind port |
4242
| | (default: ``5432``). |
4343
+-----------------+---------------------------------------------------------------------+
4444

45-
4645
Capabilities matrix
4746
-------------------
4847

@@ -60,10 +59,9 @@ D2D pipeline parameters passed through the ``--options`` flag.
6059
+--------------------------------------------+------------------------------+------------------------------+---------------------------+------------------------+--------------------------+
6160
| without ``--spin-db`` (no DB container) ||| depends on parameters | depends on parameters | depends on parameters |
6261
+--------------------------------------------+------------------------------+------------------------------+---------------------------+------------------------+--------------------------+
63-
| ``--port <port>`` ||| depends on parameters | depends on parameters | depends on parameters |
62+
| ``--db-port <port>`` ||| depends on parameters | depends on parameters | depends on parameters |
6463
+--------------------------------------------+------------------------------+------------------------------+---------------------------+------------------------+--------------------------+
6564

66-
6765
Examples
6866
--------
6967

@@ -77,8 +75,10 @@ Run mapping with database on a custom port:
7775

7876
.. code-block:: bash
7977
80-
./map-deploy-to-develop.sh ./from.tar.gz ./to.whl output.json --options "Python,Java" --spin-db --port 5433
81-
78+
./map-deploy-to-develop.sh ./from.tar.gz ./to.whl output.json \
79+
--options "Python,Java" \
80+
--spin-db \
81+
--db-port 5433
8282
8383
Script actions (high-level)
8484
---------------------------
@@ -92,7 +92,6 @@ Script actions (high-level)
9292
7. Cleans up temp directory
9393
8. Stops DB container if it was started
9494

95-
9695
Related files
9796
-------------
9897

0 commit comments

Comments
 (0)