docs: Add docs for finch vm settings command

[haytok]

In my previous pull request, we added the functionality to change the number of CPUs and memory size allocated to VMs.

• fix: add finch vm settings subcommand #887

However, at that time, we did not add documentations for the finch vm settings command.

Therefore, in this fix, we will add documentations for the finch vm settings command.

Issue #, if available: N/A

Description of changes: Details are described in this commit message.

Testing done: N/A

• I've reviewed the guidance in CONTRIBUTING.md

License Acceptance

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[haytok]

At this point, we need to manually run finch gen-docs generate to generate the documentation whenever new commands or options are added.

When we forget to generate the documentation and create a pull request, the CI cannot detect it.

Therefore, I'm planning to add a feature in a separate issue that allows the CI to detect if we forget to run finch gen-docs generate.

[pendo324]

Thanks, LGTM. I'm working on adding docs for our docs process as well (and to our PR template) so it shouldn't come as a surprise that we need to run gen-docs going forward. Automation would be nice as well (perhaps a new CI step that does diff?)

If you plan to work on some sort of doc automation, can you create an issue for it?

[haytok]

Hi, @pendo324

Thanks for comments!!!

(perhaps a new CI step that does diff?)

Yes.
I haven't been able to verify the functionality yet, but I think something like the following YAML configuration will be added.

  finch-gen-docs-generate-check:
    runs-on: ubuntu-latest
    steps:
      - name: Check to see if documents have been created for the command
      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
      - run: |
        finch gen-docs generate -p cmd/finch/
        git diff --exit-code docs/cmd/

If you plan to work on some sort of doc automation, can you create an issue for it?

OK, I'll create an issue !!!

[haytok]

I have created an issue.

• Add features not to forget to execute finch gen-docs generate -p cmd/finch/ #942

[pendo324]

Closing/opening to re-trigger CI

[pendo324]

Hmm, tests didn't trigger properly last time? Closing/opening to re-trigger CI

[pendo324]

Ah, I think the test status is expected, since we mark them as required, but they also don't run when there's only doc changes. So the e2e tests will basically never run. I'm going to override and merge this