ENDOC-522 ent-cli reorg basics and nav #536
Conversation
| @@ -51,18 +50,17 @@ ent [command] [subcommand] [name] [flags] | |||
| > ent Commands: | |||
| - app => Helper for managing an Entando App | |||
| - app-info => Displays information about an Entando App | |||
| - bundle => Helper for managing bundle functions. See below for more details | |||
| - bundle => Helper module for managing bundle functions. (See below for more details) | |||
| - bundler => export of resources from a running instance for v1 bundles only | |||
There was a problem hiding this comment.
@nshaw only mentioned version here for bundler. Thinking I'll get into the details of the v1/v5 issues in the project management page. Thought I'd keep it more generic here. Any thoughts?
There was a problem hiding this comment.
@jyunmitch Maybe even there we can use the phrase "git-based bundles (v1)". I think git-based versus docker-based is going to be the most easily understood.
There was a problem hiding this comment.
Maybe - "export resources from a running instance as a git-based (v1) bundle." Then the previous line can be "Helper module for managing docker-based (v5) bundles. (See below for more details)"
| @@ -51,18 +50,17 @@ ent [command] [subcommand] [name] [flags] | |||
| > ent Commands: | |||
| - app => Helper for managing an Entando App | |||
| - app-info => Displays information about an Entando App | |||
| - bundle => Helper for managing bundle functions. See below for more details | |||
| - bundle => Helper module for managing bundle functions. (See below for more details) | |||
| - bundler => export of resources from a running instance for v1 bundles only | |||
There was a problem hiding this comment.
Maybe - "export resources from a running instance as a git-based (v1) bundle." Then the previous line can be "Helper module for managing docker-based (v5) bundles. (See below for more details)"
| > Collected diagdata available in archive "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000.tgz" | ||
| ``` | ||
|
|
||
| ::: tip |
There was a problem hiding this comment.
don't understand why this tip is here suddenly, it seems to need some context
There was a problem hiding this comment.
there is no other context. this was its own section previously. it's not a description of how things should function or a tutorial for what to do in an expected use case. moving it to tips and tricks is an option but doesn't seem merited. either a tip or a note seems more appropriate.
| | `ent diag` | Run diagnostics on the pods currently in an Entando namespace and prepare a diagnostic tar.gz | ||
| | `ent pod grep --all "error\|fail"` | Locate error messages within EntandoApp pods | ||
|
|
||
| The command `ent diag` is a superset of operations to analyze, organize and output detailed pod information. In addition to calling `ent pod-info`, `ent diag` exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. It also generates diagnostics and returns log paths similar to the following: |
There was a problem hiding this comment.
Not sure about the word superset>> it should be a set that is bigger than something else and I don't know that that's the case.
ENDOC-525 Create new ent CLI Services page
ENDOC-524 7.1 Ent CLI-create new API management page
ENDOC-513 new bundle cli page
vuepress/docs/.vuepress/next.js
Outdated
| path: path + 'getting-started/entando-cli.md', | ||
| }, | ||
| { | ||
| title: 'ent Bundle Management', |
There was a problem hiding this comment.
Do you think lowercase ent looks okay in the left nav when everything else is capitalized? I thought we discussed dropping ent it in the nav and just having Bundle Management, API Management, etc. since the context should be obvious.
|
|
||
| # Diagnostics and Troubleshooting | ||
|
|
||
| Diagnostic information is critical to analysis and troubleshooting, and the Entando CLI (ent) is a useful tool for debugging issues with an Entando instance. The [Getting Started](../../docs/getting-started/README.md) guide includes steps to install ent in a Multipass VM. The following commands can be run from this VM for insight into an Entando Application. |
There was a problem hiding this comment.
I think we can remove the 2nd and 3rd sentences. These commands are useful against any Entando instance, not just a Multipass VM.
No description provided.