From 5b2b35d16cc4e76038343401af848c87809403d0 Mon Sep 17 00:00:00 2001 From: Omer Fahim Date: Fri, 1 Nov 2024 12:59:59 -0400 Subject: [PATCH 1/9] Update dev-usage.rst - Add Details for Accessing and Saving Harvesting Logs to Local --- .../source/container/dev-usage.rst | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index 6a1edcf7ebd..e481bcfd5ae 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -140,6 +140,48 @@ Alternatives: - If you used Docker Compose for running, you may use ``docker compose -f docker-compose-dev.yml logs ``. Options are the same. +Accessing Harvesting Log Files +------------------------------ + +1. Open a Terminal and Access Dataverse Container +Run the following command to access the Dataverse container (assuming your container is named dataverse-1): + +.. code-block:: +docker exec -it dataverse-1 bash +Code updated + +This command opens an interactive shell within the dataverse-1 container. + +2. Navigate to the Log Files Directory +Once inside the container, navigate to the directory where Dataverse logs are stored: + +.. code-block:: +cd /opt/payara/appserver/glassfish/domains/domain1/logs +Code updated + +This directory contains various log files, including those relevant to harvesting. + +3. Create a Directory for Copying Files +Create a directory where you’ll copy the files you want to access on your local machine: + +mkdir /dv/filesToCopy + +This will create a new folder named filesToCopy inside /dv. + +4. Copy the Files to the New Directory +Copy all files from the current directory to the newly created filesToCopy directory: + +cp * /dv/filesToCopy + +This command copies all files in the logs directory to /dv/filesToCopy. + +5. Access the Files on Your Mac +On your Mac, the copied files should appear in the following directory: + +docker-dev-volumes/app/data/filesToCopy + + + Redeploying ----------- From 899cc25996e25a0ddd1cbb514ae912cf927eea9a Mon Sep 17 00:00:00 2001 From: Omer Fahim Date: Fri, 1 Nov 2024 14:17:10 -0400 Subject: [PATCH 2/9] Update doc/sphinx-guides/source/container/dev-usage.rst Co-authored-by: Philip Durbin --- doc/sphinx-guides/source/container/dev-usage.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index e481bcfd5ae..7e4a640a45d 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -147,6 +147,7 @@ Accessing Harvesting Log Files Run the following command to access the Dataverse container (assuming your container is named dataverse-1): .. code-block:: + docker exec -it dataverse-1 bash Code updated From 356da8fc09c429d8776698b4bc8aa81333cb56c4 Mon Sep 17 00:00:00 2001 From: Omer Fahim Date: Fri, 1 Nov 2024 14:21:04 -0400 Subject: [PATCH 3/9] Update doc/sphinx-guides/source/container/dev-usage.rst Co-authored-by: Philip Durbin --- doc/sphinx-guides/source/container/dev-usage.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index 7e4a640a45d..bd2ff6f0382 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -156,6 +156,7 @@ This command opens an interactive shell within the dataverse-1 container. 2. Navigate to the Log Files Directory Once inside the container, navigate to the directory where Dataverse logs are stored: + .. code-block:: cd /opt/payara/appserver/glassfish/domains/domain1/logs Code updated From 9119c4b4799fd4a14223ac9c07471ef8db34f095 Mon Sep 17 00:00:00 2001 From: ofahimIQSS Date: Fri, 1 Nov 2024 14:30:37 -0400 Subject: [PATCH 4/9] Update dev-usage.rst --- doc/sphinx-guides/source/container/dev-usage.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index bd2ff6f0382..7b5274844f6 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -149,7 +149,6 @@ Run the following command to access the Dataverse container (assuming your conta .. code-block:: docker exec -it dataverse-1 bash -Code updated This command opens an interactive shell within the dataverse-1 container. @@ -159,28 +158,33 @@ Once inside the container, navigate to the directory where Dataverse logs are st .. code-block:: cd /opt/payara/appserver/glassfish/domains/domain1/logs -Code updated This directory contains various log files, including those relevant to harvesting. 3. Create a Directory for Copying Files Create a directory where you’ll copy the files you want to access on your local machine: -mkdir /dv/filesToCopy +.. code-block:: + + mkdir /dv/filesToCopy This will create a new folder named filesToCopy inside /dv. 4. Copy the Files to the New Directory Copy all files from the current directory to the newly created filesToCopy directory: -cp * /dv/filesToCopy +.. code-block:: + + cp * /dv/filesToCopy This command copies all files in the logs directory to /dv/filesToCopy. 5. Access the Files on Your Mac On your Mac, the copied files should appear in the following directory: -docker-dev-volumes/app/data/filesToCopy +.. code-block:: + + docker-dev-volumes/app/data/filesToCopy From 41a1d13288c31c938395bdab80601bc916391a15 Mon Sep 17 00:00:00 2001 From: ofahimIQSS Date: Fri, 1 Nov 2024 14:39:21 -0400 Subject: [PATCH 5/9] Update dev-usage.rst --- doc/sphinx-guides/source/container/dev-usage.rst | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index 7b5274844f6..da7d6845bb5 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -148,16 +148,16 @@ Run the following command to access the Dataverse container (assuming your conta .. code-block:: -docker exec -it dataverse-1 bash + docker exec -it dataverse-1 bash This command opens an interactive shell within the dataverse-1 container. 2. Navigate to the Log Files Directory Once inside the container, navigate to the directory where Dataverse logs are stored: - .. code-block:: -cd /opt/payara/appserver/glassfish/domains/domain1/logs + + cd /opt/payara/appserver/glassfish/domains/domain1/logs This directory contains various log files, including those relevant to harvesting. @@ -186,9 +186,6 @@ On your Mac, the copied files should appear in the following directory: docker-dev-volumes/app/data/filesToCopy - - - Redeploying ----------- From 432feb0cba801a982b7d156b8d1d19a6625817a4 Mon Sep 17 00:00:00 2001 From: ofahimIQSS Date: Fri, 1 Nov 2024 14:48:05 -0400 Subject: [PATCH 6/9] Update dev-usage.rst --- doc/sphinx-guides/source/container/dev-usage.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index da7d6845bb5..bfad3d34cf2 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -143,7 +143,7 @@ Alternatives: Accessing Harvesting Log Files ------------------------------ -1. Open a Terminal and Access Dataverse Container +1. Open a terminal and access Dataverse container. Run the following command to access the Dataverse container (assuming your container is named dataverse-1): .. code-block:: @@ -152,7 +152,7 @@ Run the following command to access the Dataverse container (assuming your conta This command opens an interactive shell within the dataverse-1 container. -2. Navigate to the Log Files Directory +2. Navigate to the Log Files directory Once inside the container, navigate to the directory where Dataverse logs are stored: .. code-block:: From 0d59b16f8c05ddc190f38efaf1891cf6750f8107 Mon Sep 17 00:00:00 2001 From: ofahimIQSS Date: Fri, 1 Nov 2024 14:57:15 -0400 Subject: [PATCH 7/9] Update dev-usage.rst --- doc/sphinx-guides/source/container/dev-usage.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index bfad3d34cf2..27fbb28dd26 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -143,7 +143,7 @@ Alternatives: Accessing Harvesting Log Files ------------------------------ -1. Open a terminal and access Dataverse container. +1. Open a terminal and access the Dataverse container. Run the following command to access the Dataverse container (assuming your container is named dataverse-1): .. code-block:: @@ -152,7 +152,7 @@ Run the following command to access the Dataverse container (assuming your conta This command opens an interactive shell within the dataverse-1 container. -2. Navigate to the Log Files directory +2. Navigate to the Log files directory. Once inside the container, navigate to the directory where Dataverse logs are stored: .. code-block:: @@ -161,7 +161,7 @@ Once inside the container, navigate to the directory where Dataverse logs are st This directory contains various log files, including those relevant to harvesting. -3. Create a Directory for Copying Files +3. Create a directory for copying files. Create a directory where you’ll copy the files you want to access on your local machine: .. code-block:: @@ -170,7 +170,7 @@ Create a directory where you’ll copy the files you want to access on your loca This will create a new folder named filesToCopy inside /dv. -4. Copy the Files to the New Directory +4. Copy the files to the new directory. Copy all files from the current directory to the newly created filesToCopy directory: .. code-block:: @@ -179,7 +179,7 @@ Copy all files from the current directory to the newly created filesToCopy direc This command copies all files in the logs directory to /dv/filesToCopy. -5. Access the Files on Your Mac +5. Access the files on Your Mac On your Mac, the copied files should appear in the following directory: .. code-block:: From c76d62a6200382e6b584e220acde64bfd33716d2 Mon Sep 17 00:00:00 2001 From: ofahimIQSS Date: Fri, 1 Nov 2024 15:03:46 -0400 Subject: [PATCH 8/9] Update dev-usage.rst --- doc/sphinx-guides/source/container/dev-usage.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index 27fbb28dd26..80e3cac989c 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -141,7 +141,7 @@ Alternatives: Options are the same. Accessing Harvesting Log Files ------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1. Open a terminal and access the Dataverse container. Run the following command to access the Dataverse container (assuming your container is named dataverse-1): From e28b6d342eddc97e2632a53cdca17cf789d58022 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Fri, 1 Nov 2024 15:27:17 -0400 Subject: [PATCH 9/9] tweaks #10996 --- .../source/container/dev-usage.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index 80e3cac989c..c02c1d4010f 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -143,7 +143,8 @@ Alternatives: Accessing Harvesting Log Files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -1. Open a terminal and access the Dataverse container. +\1. Open a terminal and access the Dataverse container. + Run the following command to access the Dataverse container (assuming your container is named dataverse-1): .. code-block:: @@ -152,7 +153,8 @@ Run the following command to access the Dataverse container (assuming your conta This command opens an interactive shell within the dataverse-1 container. -2. Navigate to the Log files directory. +\2. Navigate to the log files directory. + Once inside the container, navigate to the directory where Dataverse logs are stored: .. code-block:: @@ -161,8 +163,9 @@ Once inside the container, navigate to the directory where Dataverse logs are st This directory contains various log files, including those relevant to harvesting. -3. Create a directory for copying files. -Create a directory where you’ll copy the files you want to access on your local machine: +\3. Create a directory for copying files. + +Create a directory where you'll copy the files you want to access on your local machine: .. code-block:: @@ -170,7 +173,8 @@ Create a directory where you’ll copy the files you want to access on your loca This will create a new folder named filesToCopy inside /dv. -4. Copy the files to the new directory. +\4. Copy the files to the new directory. + Copy all files from the current directory to the newly created filesToCopy directory: .. code-block:: @@ -179,8 +183,9 @@ Copy all files from the current directory to the newly created filesToCopy direc This command copies all files in the logs directory to /dv/filesToCopy. -5. Access the files on Your Mac -On your Mac, the copied files should appear in the following directory: +\5. Access the files on your local machine. + +On your local machine, the copied files should appear in the following directory: .. code-block::