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

[Docs]: improve command section #156

Open
1 task done
flower-of-the-bridges opened this issue Feb 7, 2024 · 1 comment
Open
1 task done

[Docs]: improve command section #156

flower-of-the-bridges opened this issue Feb 7, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@flower-of-the-bridges
Copy link
Member

Documentation Revision

Some information is not clear:

  • when you use the command miactl context set, the endpoint flag is required (this is not clear also in the examples, where --endpoint is used only for self-hosted instances
  • when you have to apply JSON objects, such as for marketplace, is not clear what the supported JSON schema is.
  • in general, the command section is difficult to navigate, it would be nice to group commands into a <details> block

Code of Conduct

  • I agree to follow this project’s Code of Conduct
@flower-of-the-bridges flower-of-the-bridges added the documentation Improvements or additions to documentation label Feb 7, 2024
@silversoul93
Copy link
Contributor

Hi, I noticed other missing information in the documentation:

  • the logs verbosity levels is missing related to the --verbose flag;
  • the command miactl deploy ENVIRONMENT needs the user to specify a runtime environment. Does themiactl require the environment ID or environment Name?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants