From e1d82099d505850f479cb7c67b6327d9b9e7a137 Mon Sep 17 00:00:00 2001 From: Maxim Svistunov Date: Mon, 10 Mar 2025 15:05:31 +0100 Subject: [PATCH 1/2] Add section on generate-metadata and generate-listing commands --- ...synchronizing-content-between-servers.adoc | 2 ++ ...nd-listing-files-for-syncable-exports.adoc | 26 +++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc diff --git a/guides/common/assembly_synchronizing-content-between-servers.adoc b/guides/common/assembly_synchronizing-content-between-servers.adoc index 5fe2b5e8fa0..8a42ad76f81 100644 --- a/guides/common/assembly_synchronizing-content-between-servers.adoc +++ b/guides/common/assembly_synchronizing-content-between-servers.adoc @@ -8,6 +8,8 @@ include::modules/proc_using-upstream-server-to-sync-content-view-versions.adoc[l include::modules/proc_synchronizing-a-single-repository.adoc[leveloffset=+2] +include::modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc[leveloffset=+2] + include::modules/proc_synchronizing-a-custom-repository.adoc[leveloffset=+1] include::modules/proc_exporting-the-library-environment.adoc[leveloffset=+1] diff --git a/guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc b/guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc new file mode 100644 index 00000000000..6e205b56dae --- /dev/null +++ b/guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc @@ -0,0 +1,26 @@ +[id="generating-metadata-and-listing-files-for-syncable-exports_{context}"] += Generating metadata and listing files for syncable exports + +In most cases, when exporting content in a syncable format using root privileges and the standard commands, metadata and listing files are generated automatically. However, you must manually trigger the generation of these files in the following circumstances: + +* When a non-root user is doing the export. +* When the `--async` flag has been passed, for root or non-root user. +* When triggering API manually or using Ansible modules to do the exports. + +.Prerequisites +* The syncable export directory is accessible on disk. + +.Procedure +. To generate metadata for a syncable export that was performed asynchronously or if the metadata was lost, use the following command: ++ +[options="nowrap" subs="+quotes"] +---- +# hammer content-export generate-metadata --path=/path/to/syncable/export +---- ++ +. To generate listing files for a syncable export directory, use the following command: ++ +[options="nowrap" subs="+quotes"] +---- +# hammer content-export generate-listing --path=/path/to/syncable/export +---- From 3521a3ea458cd8cd374c83397c3a065564149d82 Mon Sep 17 00:00:00 2001 From: Maxim Svistunov Date: Wed, 18 Jun 2025 15:14:41 +0200 Subject: [PATCH 2/2] Implement feedback from review --- ...-and-listing-files-for-syncable-exports.adoc | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc b/guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc index 6e205b56dae..b78e922f4f5 100644 --- a/guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc +++ b/guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc @@ -1,26 +1,27 @@ -[id="generating-metadata-and-listing-files-for-syncable-exports_{context}"] +[id="generating-metadata-and-listing-files-for-syncable-exports"] = Generating metadata and listing files for syncable exports -In most cases, when exporting content in a syncable format using root privileges and the standard commands, metadata and listing files are generated automatically. However, you must manually trigger the generation of these files in the following circumstances: +When exporting content in a syncable format, metadata and listing files are generated automatically. +However, you must manually trigger the generation of these files in the following circumstances: * When a non-root user is doing the export. * When the `--async` flag has been passed, for root or non-root user. -* When triggering API manually or using Ansible modules to do the exports. +* When using the {Project} API or Ansible modules to do the exports. .Prerequisites * The syncable export directory is accessible on disk. .Procedure -. To generate metadata for a syncable export that was performed asynchronously or if the metadata was lost, use the following command: +. Generate metadata for a syncable export: + [options="nowrap" subs="+quotes"] ---- -# hammer content-export generate-metadata --path=/path/to/syncable/export +$ hammer content-export generate-metadata --path=/path/to/syncable/export ---- -+ -. To generate listing files for a syncable export directory, use the following command: + +. Generate listing files for a syncable export directory: + [options="nowrap" subs="+quotes"] ---- -# hammer content-export generate-listing --path=/path/to/syncable/export +$ hammer content-export generate-listing --path=/path/to/syncable/export ----