Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Document arch override for API users #1695

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Conversation

m-blaha
Copy link
Member

@m-blaha m-blaha commented Sep 13, 2024

We have documentation for CLI users (dnf5-forcearch(7)), but it's not
clear how to do the same thing through API. This patch fills the gap.

Resolves: #1596

@kontura kontura self-assigned this Sep 16, 2024
@@ -11,3 +11,4 @@ Tutorial
repos
queries
transaction
force-arch
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good, I am only thinking if it would be a bit clearer if it was added right after the session?
I like how the tutorials are ordered according to the workflow progression and adding this at the end disrupts that.

I had also one more idea that the page could be a child of the session page but I am not sure about that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Originally I was thinking about just adding the commented section to the session example - but given that this really is kind of a corner case, I didn't want to over-complicate the tutorial example.
But let me experiment with a session sub-page, it might work.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed the PR to make the forcearch tutorial a sub-section of session and I like it. What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it as well. Thank you!

We have documentation for CLI users (dnf5-forcearch(7)), but it's not
clear how to do the same thing through API. This patch fills the gap.
@kontura kontura added this pull request to the merge queue Sep 17, 2024
Merged via the queue into main with commit c162907 Sep 17, 2024
13 of 20 checks passed
@kontura kontura deleted the mblaha/doc-forcearch branch September 17, 2024 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to do forcearch as an API user
2 participants