daos icon indicating copy to clipboard operation
daos copied to clipboard

DAOS-16098 doc: Add a guide for setting up DAOS using QEMU

Open paul356 opened this issue 1 year ago • 3 comments

Add a guide for setting up DAOS using QEMU.

Signed-off-by: Pan Hao [email protected]

Before requesting gatekeeper:

  • [ ] Two review approvals and any prior change requests have been resolved.
  • [ ] Testing is complete and all tests passed or there is a reason documented in the PR why it should be force landed and forced-landing tag is set.
  • [ ] Features: (or Test-tag*) commit pragma was used or there is a reason documented that there are no appropriate tags for this PR.
  • [ ] Commit messages follows the guidelines outlined here.
  • [ ] Any tests skipped by the ticket being addressed have been run and passed in the PR.

Gatekeeper:

  • [ ] You are the appropriate gatekeeper to be landing the patch.
  • [ ] The PR has 2 reviews by people familiar with the code, including appropriate owners.
  • [ ] Githooks were used. If not, request that user install them and check copyright dates.
  • [ ] Checkpatch issues are resolved. Pay particular attention to ones that will show up on future PRs.
  • [ ] All builds have passed. Check non-required builds for any new compiler warnings.
  • [ ] Sufficient testing is done. Check feature pragmas and test tags and that tests skipped for the ticket are run and now pass with the changes.
  • [ ] If applicable, the PR has addressed any potential version compatibility issues.
  • [ ] Check the target branch. If it is master branch, should the PR go to a feature branch? If it is a release branch, does it have merge approval in the JIRA ticket.
  • [ ] Extra checks if forced landing is requested
    • [ ] Review comments are sufficiently resolved, particularly by prior reviewers that requested changes.
    • [ ] No new NLT or valgrind warnings. Check the classic view.
    • [ ] Quick-build or Quick-functional is not used.
  • [ ] Fix the commit message upon landing. Check the standard here. Edit it to create a single commit. If necessary, ask submitter for a new summary.

paul356 avatar Jun 26 '24 02:06 paul356

Ticket title is 'Add documentation for using QEMU with DAOS' Status is 'In Review' https://daosio.atlassian.net/browse/DAOS-16098

github-actions[bot] avatar Jun 26 '24 02:06 github-actions[bot]

Before landing, the CI should probably be run: spell checking, mark down syntax checking, etc.

knard38 avatar Jun 27 '24 20:06 knard38

Before landing, the CI should probably be run: spell checking, mark down syntax checking, etc.

I am currently looking on the way to run the CI over this PR.

knard38 avatar Jul 01 '24 06:07 knard38

@Michael-Hennecke , please could you have a look to the PR for checking is everything is fine for you ? Thanks in advance.

knard38 avatar Jul 10 '24 08:07 knard38

@Michael-Hennecke @knard-intel could you please take a look on this PR? It has been blocked for a while.

paul356 avatar Jul 18 '24 05:07 paul356

There is two small typos to fix. https://github.com/daos-stack/daos/actions/runs/10061323987/job/27845319209?pr=14648

knard38 avatar Jul 24 '24 07:07 knard38

Two typos are fixed. Thanks. @knard-intel

paul356 avatar Jul 24 '24 13:07 paul356

I am currently looking on the way to run the CI over this PR.

Why? There are no code changes here. What value would running it in CI add?

brianjmurrell avatar Jul 30 '24 15:07 brianjmurrell

There is two small typos to fix. https://github.com/daos-stack/daos/actions/runs/10061323987/job/27845319209?pr=14648

It seems there is part of the CI will check for Markdown Syntax. But it need not to run code related tests. But I don't know the detailed rules here.

paul356 avatar Aug 01 '24 06:08 paul356

There is two small typos to fix. https://github.com/daos-stack/daos/actions/runs/10061323987/job/27845319209?pr=14648

It seems there is part of the CI will check for Markdown Syntax. But it need not to run code related tests. But I don't know the detailed rules here.

@brianjmurrell and @paul356 , all the CI is not needed to be run for this PR. @paul356 , next time you push some modifications, could you please add the following pragma at the end of your commit message: Doc-only: true Otherwise, I am trying to find some internal QEMU experts to review your PR without so much success until now. I will also have to discuss with @Michael-Hennecke for the best location of such documentation.

knard38 avatar Aug 01 '24 13:08 knard38

@paul356 , next time you push some modifications, could you please add the following pragma at the end of your commit message: Doc-only: true

If it is only documentation changes, as this PR is, the above should not be necessary. That will be detected automatically.

brianjmurrell avatar Aug 06 '24 12:08 brianjmurrell

Understood. Thanks you both for suggestion.

paul356 avatar Aug 06 '24 13:08 paul356

@daos-stack/daos-gatekeeper please could you land this PR. According to offline discussion with @Michael-Hennecke we will move this documentation in a more suited location in a follow-on PR. @paul356 thanks again for your contributions.

@brianjmurrell : I do not understand why the approval from Michael does not appear at the top of the page.

knard38 avatar Aug 21 '24 10:08 knard38

I do not understand why the approval from Michael does not appear at the top of the page.

Michael's review was requested again after approving, so the approval is gone. But it looks like nothing changed since Michael's last approval

daltonbohning avatar Aug 21 '24 18:08 daltonbohning