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

fix(docs): add documentation for jans wrapper command #10611

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

ossdhaval
Copy link
Contributor

@ossdhaval ossdhaval commented Jan 13, 2025

Prepare


Description

Target issue

closes #issue-number-here

Implementation Details


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

  • I confirm that there is no impact on the docs due to the code changes in this PR.

Closes #10612,

@ossdhaval ossdhaval added the area-documentation Documentation needs to change as part of issue or PR label Jan 13, 2025
@ossdhaval ossdhaval self-assigned this Jan 13, 2025
@mo-auto
Copy link
Member

mo-auto commented Jan 13, 2025

Error: Hi @ossdhaval, You did not reference an open issue in your PR. I attempted to create an issue for you.
Please update that issues' title and body and make sure I correctly referenced it in the above PRs body.

@mo-auto mo-auto added comp-docs Touching folder /docs kind-bug Issue or PR is a bug in existing functionality labels Jan 13, 2025
Signed-off-by: ossdhaval <[email protected]>
Copy link
Member

@moabu moabu left a comment

Choose a reason for hiding this comment

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

The jans command is very specific to the VM setup. I don’t think it belongs under references unless there is a bigger title that indicates that. Perhaps its better off under the VM Operation Guide

@ossdhaval ossdhaval requested a review from moabu January 15, 2025 11:48
@ossdhaval
Copy link
Contributor Author

The jans command is very specific to the VM setup. I don’t think it belongs under references unless there is a bigger title that indicates that. Perhaps its better off under the VM Operation Guide

Agreed and made changes accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs kind-bug Issue or PR is a bug in existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix: fix(docs): add documentation for jans wrapper command -autocreated
4 participants