ent profile edits #537
ent profile edits #537
Conversation
|
the only file ready for review is ent-profile.md |
|
|
||
| # Profile Management | ||
|
|
||
| The [Entando CLI](entando-cli.md) can define a collection of configuration variables to full describe an Entando instance. One or more profiles can be created to store configuration settings for the instance. The `ent profile` command is available to manage and switch between the configurations of different Entando instances. Refer to `ent profile first-use-readme` for additional details. A profile with this information is automatically generated for a quickstart application. |
There was a problem hiding this comment.
full -> fully, "for the instance" -> "for a particular instance"
| ``` | ||
| ent pro use [profileName] | ||
| ``` | ||
| This attempts to fully restore a profile by informing the login and related Entando applications. |
There was a problem hiding this comment.
This sentence doesn't feel quite right. Maybe, based on the next command, "Activate the profile ent should use by default."
|
|
||
| # Profile Management | ||
|
|
||
| The [Entando CLI](entando-cli.md) can define a collection of configuration variables to full describe an Entando instance. One or more profiles can be created to store configuration settings for the instance. The `ent profile` command is available to manage and switch between the configurations of different Entando instances. Refer to `ent profile first-use-readme` for additional details. A profile with this information is automatically generated for a quickstart application. |
There was a problem hiding this comment.
can define a collection of configuration variables to full describe an Entando instance >> defines a set of variables in the profile configuration used by an Entando instance.
One or more profiles can be created to store configuration settings for the instance. The ent profile command is available to manage and switch between the configurations of different Entando instances.>> One or more profiles can be created to manage and switch between different Entando instances
There was a problem hiding this comment.
the first revision is not correct. the ent cli does not do this automatically, and unless you're running a quickstart app a profile is not created for you, so there is no profile that exists. also, the profile defines what entando instance to use, it is not used by the instance.
the second revision loses appreciable clarification. and profiles define an instance, they don't exert any governance like perform switching.
There was a problem hiding this comment.
Makes sense. I was mistaken about the way profile is used. It is confusing with the config command. I think it was the term collection and the repetition of the word configuration that felt in need of simplifying. I think switching between profiles is a common thing and this section felt a bit complex.
The term collection seems heavy handed because it is just mapping like 5 variables. Same with 'fully describe an Entando instance', the profile doesn't really describe the instance, just some of the parameters.
The ent profile command is available to manage and switch between the configurations of different Entando instances. >> Is it ent pro or ent profile? I think this sentence could be simplified to say you are switching between profiles, more direct and simple
There was a problem hiding this comment.
i think that "can define a collection of configuration variables" is the most precise phrasing. the cli can be used to resolve the ent env completely. the configuration variables necessary for / included in the profile are a small subset of that collection.
switching between profiles is very common, but entando switches between "profile and configuration" within commands, so it's important to describe the architecture/process. an instance can map to a profile. a profile has a configuration defined by a set of variables. the configuration, or configuration of the profile, is just one aspect of the profile. the profile itself includes much more that isn't defined by the configuration. further simplifications of what is written are misleading and not 100% accurate.
ent pro is shorthand for ent profile
|
|
||
| The [Entando CLI](entando-cli.md) can define a collection of configuration variables to full describe an Entando instance. One or more profiles can be created to store configuration settings for the instance. The `ent profile` command is available to manage and switch between the configurations of different Entando instances. Refer to `ent profile first-use-readme` for additional details. A profile with this information is automatically generated for a quickstart application. | ||
|
|
||
| At minimum, a configuration must consist of the key-value pairs specifying the application name and namespace. To run the application, the Kubernetes connection must also be provided. Cloud Kubernetes tools typically create a Kube context, which can be linked to an Entando profile. An overview of the current connection and profile information is provided via `ent status`. |
There was a problem hiding this comment.
Is the kubernetes connection the same as Kube context? It is confusing,
thinking ent status would be more helpful listed below. Let's discuss
There was a problem hiding this comment.
kubernetes connection is the broadest way to describe connecting to k8s, which can be done with a k8s context.
i played with that but it works better in the intro, when k8s connection is introduced. it doesn't follow the same pattern as the commands we spell out in the body of the page.
|
|
||
| ## Configuration Management | ||
|
|
||
| The output of `ent config` is a key-value archive of configuration settings related to the current profile. The following commands and keys especially notable. |
There was a problem hiding this comment.
archive>> mapping or map
The following commands and keys especially notable. >> sounds unfinished?
Otherwise, the rest of it looks good.
| | :- | :- | ||
| | `ent config --print` | Print the current config archive | ||
| | `ent config --edit` | Interactively edit a config archive | ||
| | `ent config --get {key}` | Return the value of a config key |
There was a problem hiding this comment.
I think this is in the original help but funny it's curly parens here but square brackets above.
No description provided.