ENDOC-496 update databases.md & ecr-overview.md #509
Conversation
| @@ -2,76 +2,68 @@ | |||
|
|
|||
| ## Introduction | |||
|
|
|||
| The Entando Component Repository (ECR) is meant to be a repository to | |||
| share reusable components among different Entando instances. | |||
| The Entando Component Repository (ECR) is a central repository where | |||
There was a problem hiding this comment.
central to what? not sure this is accurate or necessary
There was a problem hiding this comment.
I was thinking about the Hub
| The Entando Component Repository (ECR) is meant to be a repository to | ||
| share reusable components among different Entando instances. | ||
| The Entando Component Repository (ECR) is a central repository where | ||
| reusable components can be shared across enterprises and applications. |
There was a problem hiding this comment.
"applications and enterprises" -- "applications" should come before "enterprises" to progressively expand scope
| The following glossary relates to the ECR and related concepts: | ||
|
|
||
| ## Glossary | ||
| The following examines some of the nuts and bolts. |
There was a problem hiding this comment.
the following what? should have subject explicit
There was a problem hiding this comment.
anything that follows. It doesn't need explicit subject.
|
|
||
| ### Component | ||
|
|
||
| An Entando component - simply referred to as component - is a piece of | ||
| An Entando Component - simply referred to as component - is a piece of |
There was a problem hiding this comment.
i didn't think we were capitalizing "component" anywhere ?? i haven't seen that; is this a new rule?
| application. Examples of components are widgets, microfrontends, | ||
| content-types, labels, plugins, and static resources | ||
| application. Examples of components are widgets, micro frontends, | ||
| content-types, labels, plugins, and static resources. |
There was a problem hiding this comment.
content types - not hyphenated, and actually capitalized on other pages but could see it lowercase here
| For `spec.dbms` property you should choose `none`, then you should add all needed DB connection parameters. | ||
| After updating parameters with the one you need, you should end with a yaml like this: | ||
| For `spec.dbms` property, choose `none`. Then add the necessary DB connection parameters. | ||
| Here is an example of the resulting entandoapp.yaml: |
| Then adding those variables under the `spec.environmentVariables` section will supply connection parameters that will be used by EntandoApp. | ||
| Keep in mind that all these parameters will be applied to each of the containers in the EntandoApp pod and that they will also override existing values. | ||
| * Using `spec.dbms: "none"` directs the operator to skip the initial schema/user creation step. | ||
| * Adding the variables under the `spec.environmentVariables` section will supply connection parameters that will be used by EntandoApp. |
There was a problem hiding this comment.
"Adding variables" or specify which variables
| are two EntandoDatabaseServices that have the same DBMS vendor, it will | ||
| ### How It Works | ||
| #### Database Custom Resource | ||
| In order for the EntandoApp and Plugin deployer to choose the |
There was a problem hiding this comment.
is it a single deployer? why is deployer not capitalized? i feel like this should read "EntandoApp and plugin deployer"
There was a problem hiding this comment.
There's a s single deployer job per plugin which does its work and then shuts down.
| database of another user. | ||
| >MySQL limits database names | ||
| to 63 characters. Keep this in mind when naming your | ||
| Entando Applications and Plugins. |
Editing for grammar, standards, and better structure. Attempting to break-up big paragraphs with minor headers, shorter sentences and lists where possible.