ENDOC-533 Revamp Build and Publish a Simple Bundle #545
Conversation
| 3. Apply the bundle custom resource to Kubernetes | ||
| 4. Install the bundle into an application | ||
|
|
||
| The sections below detail the steps required to generate simple examples of each Entando bundle type. |
There was a problem hiding this comment.
what bundle type? may be good to supply idea about the types
detail the steps >> slightly awkward
There was a problem hiding this comment.
this is a leftover fragment from copy/paste; i'd started integrating v5 into this page before we changed course.
| touch widgets/example-widget.yaml | ||
| ``` | ||
|
|
||
| 3. Populate the widget descriptor file `example-widget.yaml` with a simple definition. Retain the correct YAML indentation of 2 or 4 spaces. |
There was a problem hiding this comment.
Retain the correct YAML indentation of 2 or 4 spaces. >> I know what it is saying but it feels like some context is needed. What does YAML indentation in and of itself mean? YAML indentation format/rules?
| widgets: | ||
| - widgets/example-widget.yaml | ||
| ``` | ||
| Component descriptor file names and locations (e.g. `widgets/example-widget.yaml`) are arbitrary because the bundle descriptor explicitly points to those files. Convention is to group components by type with all widgets in one directory, all page templates in another, etc. |
There was a problem hiding this comment.
would prefer this info before the example. easier to follow. Same above. Prefer all the information clumped together before the example. Otherwise it feels broken up. But not a big deal, probably personal preference
There was a problem hiding this comment.
i think so. each step is a directive. supplementary details not critical to the execution of the instruction are noted afterwards. i had thought we decided to write each step clearly/concisely to provide the more savvy readers with quick one-liners; generally developers want to see only the pertinent info and not wade through paragraphs.
There was a problem hiding this comment.
No we never decided to divide up the instructions like that. We did agree to write the steps and everything else clearly & concisely
| ``` sh | ||
| ent bundler from-git --name=example-bundle --namespace=entando --repository=https://YOUR-REMOTE-REPOSITORY.git --dry-run > example-bundle.yaml | ||
| ``` | ||
| A bundle must be published to Git before you can create a custom resource for it. Provide the URL of the bundle's remote Git repository (ends with ".git"). To include a thumbnail for your bundle, use the option `--thumbnail-file` or `--thumbnail-url`. |
There was a problem hiding this comment.
(ends with ".git") >> repeated above
There was a problem hiding this comment.
no direct repetition. i think this is left over from us wanting to make it really clear that you have to use that particular url form
|
|
||
| 7. Confirm the presence of your custom resource with the command `kubectl get EntandoDeBundle -n entando`. | ||
| 2. Click `Install`. A bundle with multiple iterations allows version selection. |
There was a problem hiding this comment.
A bundle with multiple iterations allows version selection. >> would prefer a simpler statement about selecting versions. Unless they already know the process, I would worry that non-english speakers would be confused by this
There was a problem hiding this comment.
this note is good to know before the user hits "install" so i kept it with the instruction, which should be short and sweet. "iteration" is a well-known term/concept in software.
|
|
||
| ## Install the Bundle into an Application | ||
| Your bundle should appear in `App Builder` → `Component Repository` in your Entando instance. Clicking `Install` should allow version selection if your bundle has multiple iterations. | ||
| 3. Verify the `Install` button changes to `Uninstall` to indicate that the installation completed successfully |
There was a problem hiding this comment.
simplify >> the installation is successful when the button reads Uninstall
There was a problem hiding this comment.
each step should be an instruction, telling the user to do something
| This tutorial describes how to create a simple Entando Bundle and deploy it into the [Entando Component Repository](../../../docs/getting-started/concepts-overview.md#entando-component-repository) (ECR). This process consists of 4 essential steps: | ||
|
|
||
| 1. Define the bundle component(s) | ||
| 2. Check the bundle artifacts into a Git repository |
There was a problem hiding this comment.
This step is incorrect for 7.1. Change to "Publish the bundle artifacts to a Docker registry."
|
|
||
| 2. Add the following definition to `descriptor.yaml`: | ||
| ``` yaml | ||
| code: example-bundle |
There was a problem hiding this comment.
I think it had to be an underscore in the name in the final version but we haven't finished testing with a widget...
No description provided.