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

documentation: QAT plugin documentation requires some revisions #1528

Closed
Tracked by #28
chaitanya1731 opened this issue Sep 8, 2023 · 4 comments · Fixed by #1535
Closed
Tracked by #28

documentation: QAT plugin documentation requires some revisions #1528

chaitanya1731 opened this issue Sep 8, 2023 · 4 comments · Fixed by #1535

Comments

@chaitanya1731
Copy link
Contributor

Hello, we recently encountered the documentation for the QAT plugin and noticed that it requires some revisions. Within the Modes and Configuration Options section, there is still information present about deprecated parameters. Additionally, the resource allocation information includes details about the /generic resource but lacks information regarding /dc and /cy. Do you have any upcoming plans to update the documentation, or is there any revised documentation that we might not be aware of?

@mythi
Copy link
Contributor

mythi commented Sep 8, 2023

This is the latest we have. The top-level readme has the resources up-to-date. What are the deprecated parameters?

@chaitanya1731
Copy link
Contributor Author

Thanks @mythi can you point to the top-level readme with the resources information? for deprecated parameter, one for example the -mode parameter, since this is not in CRD, users cannot set it explicitly, so from the advanced config pov, its confusing for users on how to set it along with other params..

@mythi
Copy link
Contributor

mythi commented Sep 8, 2023

"Workload authors" section

@mythi
Copy link
Contributor

mythi commented Sep 11, 2023

for deprecated parameter, one for example the -mode parameter, since this is not in CRD, users cannot set it explicitly, so from the advanced config pov, its confusing for users on how to set it along with other params..

The basic rule for the "sample" CRDs released part of the operator is that it contains all fields so users would already see the available config parameters by looking at the sample. However, I can drop -mode from the table.

This issue was closed.
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 a pull request may close this issue.

2 participants