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.

Sign up for GitHub

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

ENDOC-330 reorganization of intro pages content #507

Merged
merged 10 commits into from
May 18, 2022
Merged

ENDOC-330 reorganization of intro pages content #507

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1763cd9
ENDOC-330 reorganization of intro pages content
jyunmitch May 4, 2022
71723b5
ENDOC-330 review edits
jyunmitch May 5, 2022
461ccb2
ENDOC-330 correct links
jyunmitch May 5, 2022
bd1670e
ENDOC-330 clear conflict w/ png file
jyunmitch May 9, 2022
80f5d2f
resolve conflict
jyunmitch May 9, 2022
e55c56e
ENDOC-330 fix link
jyunmitch May 9, 2022
4fbeccb
Review edits and apply to next
jyunmitch May 16, 2022
2a729f0
add missing warning
jyunmitch May 16, 2022
b316867
ENDOC-330 Tutorial intro reworked
jyunmitch May 17, 2022
a51ca8c
ENDOC-330 final review edits
jyunmitch May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions vuepress/docs/.vuepress/next.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ module.exports = {
title: 'Solution Templates',
path: path + 'getting-started/landing-page.md',
},
{
title: 'Development Process',
path: path + 'getting-started/development-concepts.md',
},
{
title: 'Entando Architecture',
path: path + 'getting-started/concepts-overview.md',
Expand Down
4 changes: 0 additions & 4 deletions vuepress/docs/.vuepress/v70.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ module.exports = {
title: 'Solution Templates',
path: path + 'getting-started/landing-page.md',
},
{
title: 'Development Process',
path: path + 'getting-started/development-concepts.md',
},
{
title: 'Entando Architecture',
path: path + 'getting-started/concepts-overview.md',
Expand Down
62 changes: 45 additions & 17 deletions vuepress/docs/next/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,56 @@ only be available by building from source.

Entando is the leading open source **Application Composition Platform** for Kubernetes. It enables parallel teams to accelerate development and innovation of business capabilities on a modern, cloud-native, and Kubernetes-native stack.

With native support for Javascript app development, a micro frontend and microservices architecture, deployment of apps in containers that can be individually scaled up and down, and automated management of containers with Kubernetes, we simplify the move for enterprises looking to modernize across on-prem and cloud infrastructures.
It is a distributed and composable environment in which components can be built, scaled and iterated independently, helping teams build agile applications that can adapt to change.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would change one instance of "build/built" to "create" to eliminate redundancy


## Entando Architecture
![Entando Platform Development Process](./getting-started/img/concepts.png)

![entando-architecture](./entando-architecture.png)
On the Entando Platform, development of an application is organized into four stages: Create, Curate, Compose, and Consume. In the simplest terms, you create functional building blocks, curate them into a catalog, compose the blocks onto an app or website, which is then consumed by a user.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the second sentence doesn't make sense as-is. simplest option is to add "and" before "compose the blocks." without "and" it's grammatically incorrect.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's not a grammar rule to use 'and' in a list, it is convention. It is not wrong to leave out 'and' in a list.

Adding 'and' where you suggest breaks up the flow.

I would suggest we follow the 80% rule because most of the suggestions made here may make the content incrementally better, but there's just a lot bigger improvements we can make elsewhere. So unless there is a significant improvement, something is unclear, or just wrong, I would move on and not belabor the point. Some of these issues are just too small to argue about and it's taking up a lot of time. It's ok if we disagree.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

belabor is an interesting word choice. the point of this process is to offer both corrections and perspective. ignoring comments that identify valid issues prolongs this cycle and is the biggest contributor to inefficiency.


The Entando platform includes the following major elements:
## Create Components
The first step in building a modern application on Entando is to design and create each independent component or functional block. Developers can use the [Entando Component Generator](./create/component-gen-overview.md) and [Blueprint](./create/blueprint-features.md) to automate the building and packaging of project files, with the flexibility to customize while using software they are accustomed to. The modular design of apps built on Entando means new business capabilities can be integrated into your application without reworking existing systems.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be consistent with either "they" or "you," not mix these


- `Entando App Engine`: assemble micro frontends & microservices and compose them on a page.
- `Entando App Builder`: the user interface to build and design applications.
- `Entando Component Generator`: provide advanced data modeling capabilities and automatically generate the corresponding microservices and micro frontends.
- `Entando Component Repository`: a shared, internal repository to encourage code reuse across the enterprise.
- `Entando Identity Management`: token-based authentication across multiple domains and connect service providers with identity providers.
- `Entando WCMS`: a web content management system that supports headless CMS.
- (optional) `Entando Business Automation Bundle`: workflow and task automation including out of the box integration with Red Hat Process Automation Manager (PAM).
| Documentation | Tutorials |
| :------------ | :--------- |
| [Entando Component Generator](./create/component-gen-overview.md) | [Micro Frontends](../tutorials/create/mfe/) |
| [Entando Blueprint Feature](./create/blueprint-features.md) | [Microservices](../tutorials/create/ms/generate-microservices-and-micro-frontends.md) |
| [Component Generation Technologies](./create/component-gen-tech.md) | [Build and Publish Project Bundles](../tutorials/create/pb/publish-project-bundle.md) |

## Why Kubernetes?
## Curate and Share Components
On the Entando Platform, Curate and Share means development teams can bundle and share components within a central catalog. Multiple teams can collaborate on a single component or packaged business capabilities (PBCs) and share them across organizations and applications. They can test and assess components for readiness, manage and publish versions, and share metadata for continuous upgrades.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"share" is not one of the 4Cs and should not be capitalized in support of Curate

"single component" is redundant and "single" carries over to PCBs on first read, making the plurality seem wrong. should either use "component of PCB" or "components or PCBs," not mix singular and plural.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Share is part of the menu title and need to be consistent with that. Also, the items under that menu header don't really make sense without the Share.

Single is there for emphasis. Can we not belabor this point and sometimes disagree.


Instead of you doing the work to ensure your apps and services stay up and running, Kubernetes does the work for you. For each app or service, you can set resource limits, the number of pods you want backing each service, upgrade strategy, and auto-scaling. Kubernetes actively manages your cluster to match your defined resource utilization and ensures your site doesn't go down.
| Documentation | Tutorials |
| :------------ | :-------- |
| [Bundle and Component Descriptors](./curate/ecr-bundle-details.md) | [Install Bundles from a Private Git Repository](../tutorials/curate/ecr-private-git-repo.md) |
| [Filtering Bundles](./curate/ecr-bundle-filters.md) | [Install Bundle Plugins from a Private Image Repo](../tutorials/curate/ecr-private-images.md) |
| [Customize Bundle Info in App Builder](./curate/ecr-bundle-presentation-config.md) | |
| [Bundle Version and Updates FAQ](./curate/ecr-bundle-versions-faq.md) | |
| [Bundle Uninstall](./curate/ecr-uninstall-flow.md) | |

::: tip How Google Runs Containers in Production
Each week, Google deploys over 2 billion containers in production to run all of its services like Gmail, YouTube, and Search. Kubernetes is Google's open source solution to automate the management of containers at scale.
:::

Over 50% of Fortune 500 companies use Kubernetes with product offerings from Amazon Elastic Kubernetes Service (EKS), Google Cloud Platform (GKE), IBM (Red Hat) OpenShift, Microsoft Azure (AKS), and VMWare Pivotal (PKS).
## Compose an Application
The Compose stage is centered around the [Entando App Builder](./compose/app-builder.md), a low-code composition user interface. In the App Builder, application owners can assemble new components or upgrade existing ones with templates, widgets and PBCs. The [Entando Component Manager](./compose/ecm-overview.md) and [Entando Component Repository](./compose/ecr-overview.md) are integrated into the App Builder to manage your components, making the process flexible and agile.

| Documentation | Tutorials |
| :------------ | :-------- |
| [Welcome Wizard](./compose/welcome-wizard.md) | [Page Management](../tutorials/compose/page-management.md) |
| [Entando Component Repository](./compose/ecr-overview.md) | [Widgets and Fragments](../tutorials/compose/widgets-fragments.md) |
| [Entando App Builder](./compose/app-builder.md) | [Content Creation](../tutorials/compose/content-tutorial.md) |
| [Entando Component Manager](./compose/ecm-overview.md) | [Content Templates](../tutorials/compose/content-templates-tutorial.md) |
| | [Digital Assets](../tutorials/compose/digital-assets-tutorial.md) |

## Consume Applications
In the development lifecycle of an application, Consume is the execution stage where users interact with the app. On Entando, the modular design of components and services means they can be scaled individually, or as a whole, according to those interactions. Likewise, content can be updated, engine rules adapted, and upgrades made seamlessly. As a result, the development cycle is a continuous process with minimal disruptions and faster time to market.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"upgrades made seamlessly" is very awkward phrasing


| Documentation | Tutorials |
| :------------ | :-------- |
| [Accessibility](./consume/accessibility.md) | [External Identity Management System](../tutorials/devops/external-id-management.md) |
| [Entando Operator](./consume/operator-intro.md) | [Add REST API](../tutorials/devops/add-rest-api.md) |
| [Entando APIs](./consume/entando-apis.md) | [Invoke Entando core APIs](../tutorials/devops/build-core-image.md) |
| [Custom Resources](./consume/custom-resources.md) | [Change Default Datasource](../tutorials/devops/change-default-datasource.md) |
| [Entando Identity Management System](./consume/identity-management.md) | |

## Learn More
* [Entando Architecture](./getting-started/concepts-overview.md)
* [Solutions Templates](./getting-started/landing-page.md)
* [Getting Started](./getting-started/README.md)
Binary file modified vuepress/docs/next/docs/entando-architecture.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 6 additions & 21 deletions vuepress/docs/next/docs/getting-started/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,10 @@ sidebarDepth: 2
**Mac:** Entando 7 is not currently compatible with the Apple M1 ARM64 architecture found in some newer Macs.
:::

## Try Entando

You can set up Entando in two simple steps or install it manually to meet your specific needs.

* [Automatic Install](#automatic-install): The fastest way to locally install and start up Entando in Kubernetes.
* [Manual Install](#manual-install): Useful if you want a shared cluster or a custom local instance.

Once you're set up, you can [build a simple bundle and create an app](../../tutorials/create/pb/publish-simple-bundle.md) to try out the platform or walk through the [Welcome Wizard](../compose/welcome-wizard.md) in our [App Builder](../compose/app-builder.md). For a more in-depth experience, check out our [Standard Banking Demo](../../tutorials/solution/install-standard-demo.md).

## Learn about Entando

Learn about what Entando can do or explore the elements that make developing applications on Kubernetes faster and easier:

* [Introduction to Entando](../)
* [Learning Paths](../../tutorials/#learning-paths)
* [Concepts Overview](../getting-started/concepts-overview.md)

## Automatic Install
Automatically install Entando via the Entando command-line interface (CLI) and prepare a local developer environment with default settings.
Expand All @@ -41,21 +29,20 @@ https://multipass.run/#install
curl -sfL https://get.entando.org | bash
```

3. The progress of the install will be displayed on the console. Installation can take 10+ minutes depending on how long the Docker images take to download. The sequence of steps performed by the CLI is identical to the manual steps below. To understand what the CLI does, review the manual steps.
3. The progress of the install is displayed on the console. Installation can take up to 10 minutes, depending on how long the Docker images take to download. The sequence of steps performed by the CLI is identical to the manual steps below. To understand what the CLI does, review the manual steps.
4. The URL to access the Entando App Builder will print to the console once the install completes.
5. Login with username:`admin` and password: `adminadmin`. Refer to [Login to Entando](#login-to-entando) for more information and next steps.

## Manual Install

Manual installation allows you to configure a shared cluster or customize a local developer environment. The following learn-as-you-go approach gives you a working knowledge of Kubernetes as you get Entando up and running in a local environment. This is a three stage process:
Manual installation allows you to configure a shared cluster or customize a local developer environment. The following learn-as-you-go approach provides a working knowledge of Kubernetes as you install Entando in a local environment. After downloading the necessary files, your instance of Kubernetes will be up and running in <60 seconds.

This is a three stage process:

1. [Install Kubernetes](#install-kubernetes)
2. [Prepare the Kubernetes Environment](#prepare-kubernetes)
3. [Deploy Entando](#deploy-entando)


We've tested a variety of Kubernetes implementations, including Minikube, Minishift, CodeReady Containers, K3s, and Microk8s, to find the optimal combination of low CPU/memory usage, fast startup times, and minimal configuration. After downloading the necessary files, we'll have our own instance of Kubernetes up and running in <60 seconds.

::: tip What's Needed to Run Kubernetes?
Kubernetes is a container orchestrator designed to manage a server cluster. It requires at least one master node running a Linux OS. A lightweight Ubuntu virtual machine (VM) can be created in seconds with Multipass. Choosing a Type 1 hypervisor eliminates a guest OS, maximizing speed and performance.
:::
Expand Down Expand Up @@ -113,7 +100,7 @@ multipass launch --name quickstart --cpus 4 --mem 8G --disk 20G
multipass shell quickstart
```

#### Run Kubernetes
### Run Kubernetes

::: tip Why K3s?
K3s is a certified Kubernetes distribution designed for production workloads in resource-constrained environments.
Expand Down Expand Up @@ -364,9 +351,7 @@ You now have Entando up and running on Kubernetes in your local environment.
## Next Steps
Check out these resources to continue your journey with Entando!

* **Build Your First Application:** Use the [Welcome Wizard](../compose/welcome-wizard.md) to build your first application via guided prompts.

* **Try a Tutorial:** Take advantage of the [Learning Paths](../../tutorials/#learning-paths), which organize a few of the most popular tutorials by user type.
* **Try a Tutorial:** Take advantage of the [Learning Paths](../../tutorials/), which organize a few of the most popular tutorials by user type.

* **Dig Deeper into Entando Concepts:** Review the [Docs](../) sections to more deeply understand the Entando building blocks.

Expand Down
Loading