ENDOC-373 customer-portal.md #374

jyunmitch · 2021-12-18T00:43:04Z

This is a draft! Please pay special attention to structure and whether some of the information is redundant, too specific and/or not necessary.

Ignore the image sizes, not sure why some are really big when I tried to resize them.

Also ignore that a lot of the text that need to be highlighted, such as field names, are not yet done.

Lyd1aCla1r3 · 2021-12-19T23:51:55Z

vuepress/docs/next/tutorials/samples/customer-portal.md

@@ -0,0 +1,125 @@
+# Introduction
+Entando Customer Portal is a self-service application for customers to interact within your organization to administer your Entando platform and its users. You can manage users, projects and customers. You can track projects and service tickets for your application. It is a Kubernetes-native solution built on Entando’s Application Composition Platform.


this reads like an entando customer's customers have the ability to manage the customer's entando platform and everyone who uses it, like the customer's customers have control and authority... then that's kind of contradicted by the next 2 sentences. maybe reword for clarity? i'd also lead with the last sentence.

"The Entando Customer Portal provides your organization with a self-service application, making it easy to manage users, projects and customers. Using the Role Based Access Control (RBAC) model, users are granted varying levels of access to optimize your workflow process. It is a Kubernetes-native solution built on Entando’s Application Composition Platform."

How's this? I don't like to start with the Tech verbiage because that seems less important than what they get from the product? Although I am not explaining it very well.

I agree, definitely start with the business value. What you have is much better already. Tweaking further "The Entando Customer Portal enables an organization to quickly provide a modern, customer-facing self-service application for management of subscriptions and service tickets, via a lightweight integration to JIRA Service Management. Organization admins can use the included Role Based Access Control (RBAC) design to grant users different levels of access to the portal. It is a K8s..."

definitely want to lead with value! i really like the edits

Umm, how about this?
The Entando Customer Portal enables an organization to quickly provide a modern, self-service customer-facing application to manage subscriptions and service tickets. With lightweight integration on JIRA Service Management, organization admins can use the Role Based Access Control (RBAC) design to grant users varying levels of access to the Portal. It is a Kubernetes-native solution built on Entando’s Application Composition Platform.

Softened and slowed it up just a bit. It sounded really professional and informative but a bit unapproachable?

Round 5(?)
The Entando Customer Portal enables an organization to quickly provide a modern, self-service customer-facing application for management of subscriptions. It includes a lightweight integration to JIRA Service Management for access to service tickets and a Role Based Access Control (RBAC) design for granting users varying levels of access.

I dropped the last sentence since it's on the Entando page and basically implied. 2. Integrations are always "to" or "with" something, rather than "on" . 3. RBAC is independent of JIRA so I separated those clauses. 4. I'm going to add professional, informative, unapproachable to my business cards. ;)

I said just a BIT! :)
Done.

Lyd1aCla1r3 · 2021-12-19T23:53:30Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+Key Features:
+
+* Customizable service ticketing and tracking system with Jira Service management
+* Role-Based Access Control (RBAC)  Entando Identity Management System


we should lock down if role-based is hyphenated for the style guide; i've been leaving it as two words with a space between (as it was written prior to editing)

Not sure but a google search for Role-Based Access Control seemed to be hyphenated so I just went with it. Will do more research.

not a big deal; i just know i've been not using a hyphen so wanted to sync with you on that

I think the general rule should probably be when referring to RBAC specifically, it is hyphenated. In all other cases, it can be used in both ways. But is is not capitalized so have to correct that.

Lyd1aCla1r3 · 2021-12-19T23:54:43Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+* Customizable service ticketing and tracking system with Jira Service management
+* Role-Based Access Control (RBAC)  Entando Identity Management System
+* Integrated User, customer, project and subscription management 


lowercase "user"? unless Integrated User is a proper noun

it's lowercase.

Lyd1aCla1r3 · 2021-12-19T23:55:32Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+This tutorial covers 
+1. [Installation](#installaton)
+2. [Configuration for Administrators](#configuration)
+3. [A brief User Reference](#user-refernce)


it seems like "brief" should be capitalized ??

It ended up being such a small section, wasn't sure what to call it. I'm kind of waiting to see what Nathan thinks of the section. Will take 'A brief' out.

Lyd1aCla1r3 · 2021-12-19T23:55:59Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+3. [A brief User Reference](#user-refernce)
+
+# Prerequisites
+* A working instance of Entando running on Kubernetes. See [Getting Started](../../docs/getting-started/)for more information.


space after link

Lyd1aCla1r3 · 2021-12-20T00:51:45Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+3. To assign projects
+	* Use the drop-down menu under Action on the right side and choose → 
+    Manage Users
+    * Find the user and click Submit


would say "Select" instead of "Find" - more precise
need line break here

Lyd1aCla1r3 · 2021-12-20T00:53:30Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+### User Reference
+
+All Customer Portal users need Jira Service Management credentials and Access provided by your organization administrator. You can request and track subscriptions and create and track service tickets.


Access capitalized? or lowercase?
you can request and track, or the administrator can?

mistake, lowercase.
yes, the users can too

Lyd1aCla1r3 · 2021-12-20T00:55:36Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+All Customer Portal users need Jira Service Management credentials and Access provided by your organization administrator. You can request and track subscriptions and create and track service tickets.
+
+Once you login to your Customer Portal, you will see your list of customers. Click on any customer to see the details and to track their projects.


"the details" -> what details? would say "their details" or "customer details"

kind of a mess! reworking

Lyd1aCla1r3 · 2021-12-20T00:56:37Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+![Customer Portal Open Ticket](./images/custportal-open-ticket.png)
+
+2. To Request a Subscription or track all Tickets, use the same Action pull-down menu and choose the corresponding option.


the capitalization here is odd...

Lyd1aCla1r3 · 2021-12-20T00:56:51Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+Once you login to your Customer Portal, you will see your list of customers. Click on any customer to see the details and to track their projects.
+
+1. To create a Service Ticket for a project, use the Action pull-down menu  → Open Ticket


service ticket now capitalized??

nshaw · 2021-12-20T22:36:55Z

vuepress/docs/next/tutorials/samples/customer-portal.md

@@ -0,0 +1,125 @@
+# Introduction


I think we need the 2nd level nav in the left bar so add this to the top:

--- sidebarDepth: 2 ---

I was wondering why the nav was incomplete, thought I was confused about the header level that was included but now it makes sense. :)

nshaw · 2021-12-20T22:52:16Z

@jyunmitch Adding the left nav 2nd level option will help a lot but I feel like the overall structure needs to be a little more obvious to the user. Maybe this: (yes, I used a colon)

Installation
- Prerequisites
- Automatic Install via the Hub (TBD, this would be from the 7.0 AppBuilder itself)
- Manual Install via ent cli (basically what you have now)
Configuration
Managing the Portal
- Much of what you have now - adding users, customers, project, subs falls under this
Using the Portal
- Maybe a short section on the other roles - customer, partner, suppo
Application Details (same name as Standard Demo? Or maybe Technical Details)
Resources

Lyd1aCla1r3 · 2021-12-23T17:18:25Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+# Entando Customer Portal 
+## Overview
+The Entando Customer Portal enables an organization to quickly provide a modern, self-service customer-facing application for management of subscriptions. It includes a lightweight integration to JIRA Service Management for access to service tickets and a Role Based Access Control (RBAC) design for granting users varying levels of access.



Role-based access control ??

It's most often 'role-based access control' but sometimes it is capitalized and not hyphenated. In this case, I like that it gets highlighted so I'm tempted to leave it as is.

We have it in caps above, but hyphenated here. Maybe just drop the hyphen at line 12.

Lyd1aCla1r3 · 2021-12-23T17:19:31Z

vuepress/docs/next/tutorials/samples/customer-portal.md

-## Quick Install from Entando Hub
+### Automatic Install with App Builder
+Install the Customer Portal in a few simple steps from the Entando App Builder. 
+1. Go to the Repository from the left navigation bar, enter Entando Hub in the Registry field at the top of the page. You will now have access to the Hub.


, then enter - otherwise 2 sentences or ;

Lyd1aCla1r3 · 2021-12-23T17:29:35Z

vuepress/docs/next/tutorials/samples/customer-portal.md

-from the left menu →  `Page` → `Mangement` <br>
-find `Customer Portal` under `Page Tree` list<br>
-from the `Actions` pull-down menu →  `View Published Page`
+2. `Install` the two bundles for the Customer Portal from the Catalog. Once completed, it is ready for use. Update the bundle version at any time. 


"Once completed, the Portal is ready for use." minor and should be obv but someone may confuse the subjects and think "it" = bundles

my question reading this is: what is the best practice for which bundle version to use? i would assume latest? i would say "Update a bundle version..."; "the" implies there is just one version, or you're referring to only one of the two bundles.

The reason that sentence was there was to highlight the advantage of the Hub and its simple versioning option. So I moved it to the intro part of the install.

Lyd1aCla1r3 · 2021-12-23T19:59:03Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+### JIRA Service Management 
+
+The administrator begins at Jira Service Management to create users, projects, define the organization, and configure the service ticket system.


awkward phrasing... "The administrator uses..."? "begins" assigns an order governing operations that doesn't really exist; the administrator can be doing all sorts of things before this.
just noting that sometimes a comma is used before "and" (like above) and sometimes it's not (line 13)

the admin person does have to create users at Jira before doing anything else, so I wanted to make sure they understood that. They can't do anything here without that.

As for the last comma before 'and', I believe for three or less items, it's optional. For listing more than three, the last comma is recommended, but not required because it might lead readers to think the last two items on the list might be related.

Still feels awkward to me. Maybe just change to "The administrator makes use of Jira Service Management..."

How about 'utilizes'? Because the word users is everywhere, it sounded wrong to use the word 'use' here.

Lyd1aCla1r3 · 2021-12-23T19:59:40Z

vuepress/docs/next/tutorials/samples/customer-portal.md


-A. **Define the Realm Setting**. The Realm is a set of users, credentials, roles, and groups. A user belongs to and logs into a Realm. 
+Go to Customers to add organizations and projects. Once added, click on the name of the organization to get the ID from the URL which is needed later. \


would rephrase to clarify the URL is not needed later

Lyd1aCla1r3 · 2021-12-23T20:00:45Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+The `Realm` is a set of users, credentials, roles, and groups. A user belongs to and logs into a `Realm`. 
+
+* **Create Roles**\
+You can  use the default roles by clicking on `Client Roles` and choosing `entandodemo-customerportal-server`. Access for each role is defined as follows:


extra space: can use (minor)

Lyd1aCla1r3 · 2021-12-23T20:02:30Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+    * `cp-admin` - admin access for the Customer Portal
+
+* **Create New Users**: \
+For a new user, you must create them first in Jira Service Management to integrate them into  your application. Then they are created and configured in the Entando ID Management System for access to the Customer Portal.


awkward phrasing... what about: "A user must be created in Jira Service Management before they can be integrated into your application." ?

Lyd1aCla1r3 · 2021-12-23T20:07:54Z

vuepress/docs/next/tutorials/samples/customer-portal.md


-## Manual Install 
-Top install the Entando Customer Portal manually to your specific environment, go to the [Entando Github Repository](https://github.com/entando-samples/customer-portal/tree/main/application) and refer to the README.MD there for more details.
+To go directly to your Portal, navigate to Pages Management, use the Actions for the Customer Portal and select View Published Page.


after reading through this in its entirety i think we need to set some rules for how to treat terms, e.g. select View Published Page vs select "View Published Page" vs select 'View Published Page'

the option is literally 'View Published Page' so that's what they'd click on. It should have been backticked

jyunmitch · 2021-12-23T21:22:52Z

vuepress/docs/next/tutorials/samples/customer-portal.md

-from the left menu →  `Page` → `Mangement` <br>
-find `Customer Portal` under `Page Tree` list<br>
-from the `Actions` pull-down menu →  `View Published Page`
+2. `Install` the two bundles for the Customer Portal from the Catalog. Once completed, it is ready for use. Update the bundle version at any time. 


The reason that sentence was there was to highlight the advantage of the Hub and its simple versioning option. So I moved it to the intro part of the install.

jyunmitch · 2021-12-23T21:29:24Z

vuepress/docs/next/tutorials/samples/customer-portal.md


-## Manual Install 
-Top install the Entando Customer Portal manually to your specific environment, go to the [Entando Github Repository](https://github.com/entando-samples/customer-portal/tree/main/application) and refer to the README.MD there for more details.
+To go directly to your Portal, navigate to Pages Management, use the Actions for the Customer Portal and select View Published Page.


the option is literally 'View Published Page' so that's what they'd click on. It should have been backticked

jyunmitch · 2021-12-23T21:38:17Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+### JIRA Service Management 
+
+The administrator begins at Jira Service Management to create users, projects, define the organization, and configure the service ticket system.


the admin person does have to create users at Jira before doing anything else, so I wanted to make sure they understood that. They can't do anything here without that.

As for the last comma before 'and', I believe for three or less items, it's optional. For listing more than three, the last comma is recommended, but not required because it might lead readers to think the last two items on the list might be related.

jyunmitch · 2021-12-23T21:58:03Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+# Entando Customer Portal 
+## Overview
+The Entando Customer Portal enables an organization to quickly provide a modern, self-service customer-facing application for management of subscriptions. It includes a lightweight integration to JIRA Service Management for access to service tickets and a Role Based Access Control (RBAC) design for granting users varying levels of access.



It's most often 'role-based access control' but sometimes it is capitalized and not hyphenated. In this case, I like that it gets highlighted so I'm tempted to leave it as is.

jyunmitch · 2021-12-23T22:25:00Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+* Keycloak integration for role based access controls
+* Integration with JIRA Service Management for a customizable ticketing system 
+* Micro frontends using React and Angular and co-existing on the same dashboard page


@nshaw can you check these? I copied these over from the Standard Banking Demo and added the ones I knew of.

@jyunmitch One of the points of the Standard Demo is to demonstrate the features of the Entando Platform. We don't have the same goal with other templates so we can adjust the language. You already have a good bullet list in the Overview - Key Features so I'm not sure this is needed.

nshaw · 2022-01-03T01:26:27Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+* Keycloak integration for role based access controls
+* Integration with JIRA Service Management for a customizable ticketing system 
+* Micro frontends using React and Angular and co-existing on the same dashboard page


@jyunmitch One of the points of the Standard Demo is to demonstrate the features of the Entando Platform. We don't have the same goal with other templates so we can adjust the language. You already have a good bullet list in the Overview - Key Features so I'm not sure this is needed.

nshaw · 2022-01-03T01:27:16Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+### Prerequisites
+* A working instance of Entando running on Kubernetes. See [Getting Started](../../docs/getting-started/) for more information or [install Entando on any Kubernetes provider](../#operations). 
+* Use the Entando CLI command `ent check-env develop` to verify all dependencies
+* Docker installed and running


Docker isn't needed unless someone is building the Customer Portal so this can be removed.

should this be noted in the manual installation section?

@jyunmitch Nope, it's only required if you're going to build your own copy of the Customer Portal from source. We have some tips on that in the PDA doc but I don't think it's needed here. That's the kind of thing I would definitely point them to the source repository on rather than try to document it here.

nshaw · 2022-01-03T01:28:52Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+* Docker installed and running
+
+### Automatic Install with App Builder
+Install the Customer Portal in a few simple steps by integrating the Entando Hub into your App Builder. In the Hub, you can update or roll back versions of a bundle at any time.


Eventually, we'll want to point to the Hub documentation for this process. Here I would remove "In the Hub, you can update or roll back versions of a bundle at any time." We don't have that feature completely ready. And technically, doing that is from within the App Builder, using the integration to the Hub - rather than "In the Hub"

nshaw · 2022-01-03T01:30:36Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+### Automatic Install with App Builder
+Install the Customer Portal in a few simple steps by integrating the Entando Hub into your App Builder. In the Hub, you can update or roll back versions of a bundle at any time.
+1. From your App Builder, go to the Repository from the left navigation bar. Enter Entando Hub in the Registry field at the top of the page. You will now have access to the Hub.


If the Hub is already configured, then this is "Select the Entando Hub at the top right of the page." If it's configured they will need to enter both the name and the Hub API URl to set it up initially. That's what we'll want to document in one place.

nshaw · 2022-01-03T01:31:10Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+2. `Install` the two bundles for the Customer Portal from the Catalog. Once complete, the Portal is ready for use. 
+
+To go directly to your Portal, navigate to `Pages Management`, use the `Actions` for the Customer Portal and select `View Published Page`.


"for the Customer Portal page"

nshaw · 2022-01-03T01:36:28Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+     3. Send an email to the user to activate their account and set a new password: \
+     Go to `Credentials` header. \
+     Under `Credential Reset`, in the `Reset Actions` → `Update Password`. For external users, the recommendation is to extend the `Expires In` setting to a minimum of 2 days. \


Let's remove the "For external users" sentence. That's guidance for our own use, not a technical note.

nshaw · 2022-01-03T01:39:20Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+    * `cp-admin` - admin access for the Customer Portal
+
+* **Create New Users**: \
+Each new user must have a Jira Service Management account before they can be added to the Entando ID Management System for access to the Customer Portal.


This statement isn't quite right. Users can have access just to the Customer Portal (and therefore only need keycloak) for managing subscriptions and project information. They also need a Jira Service Management account if they will also be creating service tickets or directly accessing tickets in Jira.

Got it. In the work instructions, it sounded as if every user for the Customer Portal needed a Jira account. It said the email they enter in Keycloak has to match that used in Jira but that won't matter if all they have access to is project information and subscriptions?

nshaw · 2022-01-03T01:39:40Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+       `Username`: a unique name\
+       `Email`: must use the same address used in Jira\
+       `User Enabled` → On\
+       `Email Verified` → Off\


Let's remove this line. That's up to the admin.

nshaw · 2022-01-03T01:44:30Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+from the left menu →  `Page` → `Mangement` \
+find `Customer Portal` under `Page Tree` list \
+from the `Actions` pull-down menu →  `View Published Page`
+


I'm not sure where it should live but we still need the config steps for 1) enabling the mail mapper in keycloak per https://github.com/entando-samples/customer-portal/tree/main/application "The built-in mapper for email must be enabled on the server client so that user accounts can be retrieved from Jira and tickets created used that account information.", and 2) using the cp_admin_config.page to configure the Customer Portal to connect to JIRA Service Management.

As a TODO we still also need a way to configure the Customer Portal to let it work with a specific Jira Service Management instance. There are a couple tickets open to finish that work.

added some bullet points under Entando ID Management in the document for now. We can discuss more where it needs to be permanently.

nshaw · 2022-01-03T01:47:42Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+     Click `Send Email`. \
+
+     4. Go to Role Mapping. \
+     Select the appropriate `Realm Roles` from the `Available Roles` and click `Add Selected` to assign. \


This sentence should be adjusted. Per the original doc "A full admin user will also need the realm_management client, realm-admin role in order to Manage Users in the portal". Regular users of the Customer Portal will not need this role.

nshaw · 2022-01-04T21:46:35Z

vuepress/docs/next/docs/component-generator/blueprint-features.md

@@ -20,7 +20,7 @@ The Entando Blueprint uses JHipster technology based on Embedded JavaScript (EJS

 For more information:
 * Install [JHipster Entando Blueprint](https://github.com/entando/generator-jhipster-entando/blob/master/README.md)
-* Try implementing an Entando Blueprint-- [Create microservices and micro frontents](../../tutorials/micro-frontends/react.html)
+* Try implementing an Entando Blueprint-- [Create microservices and micro frontents](../../tutorials/micro-frontends/react.md)


Darn, I knew this looked familiar. I just fixed this in my PR too...

nshaw · 2022-01-04T21:47:32Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+# Entando Customer Portal 
+## Overview
+The Entando Customer Portal enables an organization to quickly provide a modern, self-service customer-facing application for management of subscriptions. It includes a lightweight integration to JIRA Service Management for access to service tickets and a Role Based Access Control (RBAC) design for granting users varying levels of access.



We have it in caps above, but hyphenated here. Maybe just drop the hyphen at line 12.

nshaw · 2022-01-04T21:48:44Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+Install the Customer Portal in two simple steps by integrating the Entando Hub into your App Builder. 
+1. From your App Builder, go to the Repository from the left navigation bar. Select the Entando Hub at the top right of the page if it has already been configured. If it has not been configured, enter Entando Hub and the API URL to initialize the Hub.
+
+2. `Install` the two bundles for the Customer Portal from the Catalog. 


There are 2 steps so let's change this to 'Deploy' and 'Install'...

nshaw · 2022-01-04T21:51:46Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+2. `Install` the two bundles for the Customer Portal from the Catalog. 
+
+3. To navigate to your Portal: 
+   * from the left menu →  `Page` → `Mangement` 


Typo "Management"

Maybe I've been doing something different but I've been including an imperative and capitalizing the first word. Have we standardized there?

Go to the 'App Builder' → 'Page → 'Management

Find the 'Customer Portal' page

Select 'View Published Page' from the 'Actions' menu.

nshaw · 2022-01-04T21:54:52Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+The administrator begins at Jira Service Management to create users, projects, define the organization, and configure the service ticket system.
+
+Users who need access to the Customer Portal beyond subscription and project information, must have a Jira Service Management account.


"Customer Portal," <- add comma

nshaw · 2022-01-04T21:58:27Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+
+### JIRA Service Management 
+
+The administrator begins at Jira Service Management to create users, projects, define the organization, and configure the service ticket system.


Still feels awkward to me. Maybe just change to "The administrator makes use of Jira Service Management..."

nshaw · 2022-01-04T22:10:10Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+  5. Under `Groups`, assign roles to groups as needed. Roles are additive.
+
+::: tip Notes:
+* The built-in mapper for email must be enabled on the server client so that user accounts can be retrieved from Jira and tickets created use that account information.


These need to be front and center right after the install since they are the first steps required to get the portal working. Let's move the tips to their own section at the top of Configuration, maybe as Initial Configuration Steps? What you have is fine for content and I opened ENDOC-403 for the next round of changes.

nshaw · 2022-01-04T22:11:36Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+### Prerequisites
+* A working instance of Entando running on Kubernetes. See [Getting Started](../../docs/getting-started/) for more information or [install Entando on any Kubernetes provider](../#operations). 
+* Use the Entando CLI command `ent check-env develop` to verify all dependencies.
+


Add Jira Service Management as a prerequisite. It's mentioned above but better to explicitly declare it.

nshaw · 2022-01-04T22:12:33Z

vuepress/docs/next/tutorials/samples/customer-portal.md

+### Administrators
+In order to configure the Customer Portal and its users, the administrator will need Jira Service Management and Entando Identity Management System credentials. The administrator can create and configure users and groups, assign roles and projects, and track service tickets.  They can also customize the ticketing system. 
+
+### JIRA Service Management 


Lowercase "Jira". I know I've done that incorrectly elsewhere.

nshaw

Looks good! I don't think we want to activate this on 6.3.2 until we have the remaining config steps so I added a note on ENDOC-403 to remind on us of that.

ENDOC-373 customer-portal.md

7ee7985

jyunmitch requested review from nshaw and Lyd1aCla1r3 December 18, 2021 00:43

Lyd1aCla1r3 reviewed Dec 20, 2021

View reviewed changes

nshaw reviewed Dec 20, 2021

View reviewed changes

ENDOC-373 edits to customer-portal

969471a

Lyd1aCla1r3 reviewed Dec 23, 2021

View reviewed changes

jyunmitch added 3 commits December 23, 2021 15:02

ENDOC-373 fix links and replace .html to .md for link checker issues

e36cf4e

ENDOC-373 edits to customer-portal.md

5e434d9

ENDOC-373 fix link

5431c75

jyunmitch commented Dec 23, 2021

View reviewed changes

nshaw requested changes Jan 3, 2022

View reviewed changes

edits and corrections customer-portal.md

3c95771

nshaw requested changes Jan 4, 2022

View reviewed changes

jyunmitch added 2 commits January 5, 2022 09:03

edits from reviews

f9194ff

edits from reviews

26ec79c

nshaw approved these changes Jan 5, 2022

View reviewed changes

nshaw merged commit 515fc4e into main Jan 5, 2022

nshaw deleted the ENDOC-373 branch January 5, 2022 21:07

		@@ -0,0 +1,125 @@
		# Introduction
		Entando Customer Portal is a self-service application for customers to interact within your organization to administer your Entando platform and its users. You can manage users, projects and customers. You can track projects and service tickets for your application. It is a Kubernetes-native solution built on Entando’s Application Composition Platform.


		### User Reference

		All Customer Portal users need Jira Service Management credentials and Access provided by your organization administrator. You can request and track subscriptions and create and track service tickets.


		All Customer Portal users need Jira Service Management credentials and Access provided by your organization administrator. You can request and track subscriptions and create and track service tickets.

		Once you login to your Customer Portal, you will see your list of customers. Click on any customer to see the details and to track their projects.


		![Customer Portal Open Ticket](./images/custportal-open-ticket.png)

		2. To Request a Subscription or track all Tickets, use the same Action pull-down menu and choose the corresponding option.


		Once you login to your Customer Portal, you will see your list of customers. Click on any customer to see the details and to track their projects.

		1. To create a Service Ticket for a project, use the Action pull-down menu → Open Ticket


		### JIRA Service Management

		The administrator begins at Jira Service Management to create users, projects, define the organization, and configure the service ticket system.


		A. Define the Realm Setting. The Realm is a set of users, credentials, roles, and groups. A user belongs to and logs into a Realm.
		Go to Customers to add organizations and projects. Once added, click on the name of the organization to get the ID from the URL which is needed later. \


		2. `Install` the two bundles for the Customer Portal from the Catalog. Once complete, the Portal is ready for use.

		To go directly to your Portal, navigate to `Pages Management`, use the `Actions` for the Customer Portal and select `View Published Page`.


		The administrator begins at Jira Service Management to create users, projects, define the organization, and configure the service ticket system.

		Users who need access to the Customer Portal beyond subscription and project information, must have a Jira Service Management account.

ENDOC-373 customer-portal.md #374

ENDOC-373 customer-portal.md #374

Conversation

jyunmitch commented Dec 18, 2021

Choose a reason for hiding this comment

jyunmitch Dec 20, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nshaw commented Dec 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jyunmitch Dec 20, 2021 •

edited

Loading