Add section on generate-metadata and generate-listing commands #3721
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
Needs tech review
|
The PR preview for 3521a3e is available at theforeman-foreman-documentation-preview-pr-3721.surge.sh The following output files are affected by this PR: |
Contributor
maximiliankolb
left a comment
maximiliankolb
left a comment
There was a problem hiding this comment.
some minor suggestions. I can test this after style review is done.
guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc
Outdated
Show resolved
Hide resolved
pr-processor
bot
added
Needs re-review
and removed
Waiting on contributor
Contributor
Author
|
@maximiliankolb Thank you Max! All feedback implemented. Could you please test this? |
Lennonka
requested changes
Jun 23, 2025
Contributor
Lennonka
left a comment
Lennonka
left a comment
There was a problem hiding this comment.
A couple of suggestions.
| [id="generating-metadata-and-listing-files-for-syncable-exports"] | ||
| = Generating metadata and listing files for syncable exports | ||
|
|
||
| When exporting content in a syncable format, metadata and listing files are generated automatically. |
Contributor
There was a problem hiding this comment.
Suggested change
| When exporting content in a syncable format, metadata and listing files are generated automatically. | |
| When you export content in a syncable format, {Project} generates metadata and listing files automatically. |
Avoid passive voice
| = Generating metadata and listing files for syncable exports | ||
|
|
||
| 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: |
Contributor
There was a problem hiding this comment.
Suggested change
| However, you must manually trigger the generation of these files in the following circumstances: | |
| Trigger the generation of these files manually under the following circumstances: |
Reducing fluff.
Any of the circumstances or all of them at once?
| * When using the {Project} API or Ansible modules to do the exports. | ||
|
|
||
| .Prerequisites | ||
| * The syncable export directory is accessible on disk. |
Contributor
There was a problem hiding this comment.
Suggested change
| * The syncable export directory is accessible on disk. | |
| * You can access the syncable export directory for writing. |
Avoid passive voice + clarity
pr-processor
bot
added
Waiting on contributor
maximiliankolb
requested changes
Jun 30, 2025
Contributor
maximiliankolb
left a comment
maximiliankolb
left a comment
There was a problem hiding this comment.
I currently fail to reproduce this. Can you please check the commands?
| + | ||
| [options="nowrap" subs="+quotes"] | ||
| ---- | ||
| $ hammer content-export generate-metadata --path=/path/to/syncable/export |
Contributor
There was a problem hiding this comment.
I tried this command on Foreman/Katello 3.14/4.16 but failed:
$ hammer content-export complete repository --organization "Example" --product-id 6 --name "Client" --format=syncable
$ rm -fr /var/lib/pulp/exports/Example/Export-SYNCABLE-Client-40/2.0/2025-06-30T09-04-45-00-00/custom/AlmaLinux_10/Client/repodata/
$ hammer content-export generate-metadata --path=/var/lib/pulp/exports/Example/Export-SYNCABLE-Client-40/2.0/2025-06-30T09-04-45-00-00/
Error: Unrecognised option '--path'.
See: 'hammer content-export generate-metadata --help'.
$ rpm -qa "rubygem-hammer_cli_katello"
rubygem-hammer_cli_katello-1.16.1-1.el9.noarch
Refs SPEC file Hammer CLI plugin for katello
I also checked on Foreman 3.15/Katello 4.17, neither generate-metadata nor generate-listing commands have the --path option.
Member
|
Moving to draft while we look for a new owner. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes are you introducing?
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
https://issues.redhat.com/browse/SAT-24915
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into: