Merge pull request #4613 from dlabrecq/docs

Update README and RELEASE

Author: dlabrecq

apps/koku-ui-hccm/README.md

@@ -43,12 +43,12 @@ sudo bash scripts/patch-etc-hosts.sh
 3. Clone the repository, and open a terminal in the base of this project.
 4. Run the command `npm install` to install all the dependencies.
 
-## Building
+## Building koku-ui-hccm
 ```
 npm build
 ```
 
-## Testing
+## Testing koku-ui-hccm
 ```
 npm test
 ```
@@ -57,7 +57,7 @@ npm test
 
 Note that this approach currently supports the Insights stage and prod environments.
 
-1. Start development server
+1. Start development server in apps/koku-ui-hccm
 ```
 npm start
 ```
@@ -82,50 +82,50 @@ Refer to the [serving files locally][serving-files-locally] section of cloud ser
 make dev-static-node
 ```
 
-2. Start development server in Koku UI repo
+2. Start development server for Koku UI in apps/koku-ui-hccm
 ```
 npm start:csb
 ```
 
-### Running Koku UI with local Koku microfrontend (MFE)
+### Running Koku UI with local ROS UI
 
-Refer to the [koku-ui-mfe README][koku-ui-mfe-readme] for more details
+Refer to the [koku-ui-ros README][koku-ui-ros-readme] for more details
 
-1. Start development server in Koku MFE repo
+1. Start development server in apps/koku-ui-ros
 ```
 npm start:static
 ```
 
-2. Start development server in Koku UI repo
+2. Start development server in apps/koku-ui-hccm
 ```
-npm start:mfe
+npm start:ros
 ```
 
-### Running Koku UI with local Koku microfrontend (MFE) and Cloud Services Backend
+### Running Koku UI with local ROS UI and Cloud Services Backend
 
-Refer to the [serving files locally][serving-files-locally] section of cloud services config and the [koku-ui-mfe README][koku-ui-mfe-readme] for more details
+Refer to the [serving files locally][serving-files-locally] section of cloud services config and the [koku-ui-ros README][koku-ui-ros-readme] for more details
 
 1. Serve files locally from Cloud Services Backend repo
 ```
 make dev-static-node
 ```
 
-2. Start development server in Koku MFE repo
+2. Start development server in apps/koku-ui-ros
 ```
 npm start:static
 ```
 
-3. Start development server in Koku UI repo
+3. Start development server in apps/koku-ui-hccm
 ```
-npm start:csb:mfe
+npm start:csb:ros
 ```
 
 ## Running local instances of Koku UI and Koku API
 #### Koku UI
 
 Note that this approach currently supports the Insights stage and prod environments.
 
-1. Start development server
+1. Start development server in apps/koku-ui-hccm
 ```
 npm start
 ```
@@ -209,7 +209,7 @@ This [RELEASE][release-doc] doc describes how to release Koku UI to each staging
 [codecov-badge]: https://codecov.io/gh/project-koku/koku-ui/graph/badge.svg?token=1hjFIy1cRe
 [Jira]: https://issues.redhat.com/projects/COST/
 [koku-readme]: https://github.com/project-koku/koku#readme
-[koku-ui-mfe-readme]: https://github.com/project-koku/koku-ui-mfe#readme
+[koku-ui-ros-readme]: https://github.com/project-koku/koku-ui/blob/prod-ros/apps/koku-ui-ros/README.md
 [license-badge]: https://img.shields.io/github/license/project-koku/koku-ui.svg?longCache=true
 [nodejs]: https://nodejs.org/en/
 [npm]: https://www.npmjs.com/

apps/koku-ui-hccm/RELEASE.md

@@ -1,58 +1,36 @@
 # Releasing Koku UI
 
-This doc describes how to release Koku UI to each staging environment. Note that this should be done in order for testing purposes; stage-stable, prod-beta, and finally prod-stable
+This doc describes how to release Koku UI to each staging environment. Note that this should be done in order for testing purposes.
 
 ## Release script
 
 The release script creates a PR with a unique SHA, used for a namespace \`ref\` in the app-interface repo. The script also ensures that code is always pulled from the correct branches. For example, we always:
 
-1. Pull from master when pushing to stage-stable
-2. Pull from stage-stable when pushing to prod-beta
-3. Pull from prod-beta when pushing to prod-stable
+1. Pull from master when pushing to prod-hccm
 
-Please allow the PR to build successfully and merge before running the script again for the next branch.
+Note: Pushing to master automatically deploys to the stage.
 
-### Release to stage-stable
+Please allow the PR to build successfully and merge before running the script again.
 
-```
-sh scripts/release-branch.sh -s
-```
-
-### Release to prod-beta
-
-```
-sh scripts/release-branch.sh -b
-```
-
-### Release to prod-stable
+### Release to prod-hccm
 
 ```
 sh scripts/release-branch.sh -p
 ```
 
 ## Deployment
 
-After all PRs have been merged, update the \`hccm-frontend\` resource in https://gitlab.cee.redhat.com/service/app-interface/-/blob/master/data/services/insights/hccm/deploy-clowder.yml
+After all PRs have been merged, update the \`koku-ui-hccm\` resource in https://gitlab.cee.redhat.com/service/app-interface/-/blob/master/data/services/insights/hccm/deploy-clowder.yml
 
 Use the latest commit of each branch to update namespaces \`ref\` in the app-interface repo. Don't use a merge commit, SHAs must be unique when images are created for each branch.
 
 ```
-- name: hccm-frontend
+- name: koku-ui-hccm
   ...
-    # Stage Stable Deployment
-  - namespace:
-      $ref: /services/insights/frontend-operator/namespaces/stage-frontends.yml
-    ref: 4bdd960da2fe34ed8964acfcbc2d3267a752f3e5 // Replace with latest SHA for stage-beta branch
-    ...
-    # Prod Beta Deployment
-  - namespace:
-      $ref: /services/insights/frontend-operator/namespaces/prod-beta-frontends.yml
-    ref: 23909da4ea017963caa78d59168054db842ce014 // Replace with latest SHA for prod-beta branch
-    ...
     # Prod Stable Deployment
   - namespace:
       $ref: /services/insights/frontend-operator/namespaces/prod-frontends.yml
-    ref: c7f6c75fd1e895afbc05a2a6d26835fa16a0edfa // Replace with latest SHA for prod-stable branch
+    ref: c7f6c75fd1e895afbc05a2a6d26835fa16a0edfa // Replace with latest SHA for prod-hccm branch
     ...
 ```
 
@@ -62,17 +40,16 @@ After releasing to each staging environment, open an incognito window and view o
 
 Please ensure expected changes have been updated before releasing to the next staging environment.
 
-1. For stage-stable, view https://console.stage.redhat.com/openshift/cost-management/
-2. For prod-beta, view https://console.redhat.com/beta/openshift/cost-management/
-3. For prod-stable, view https://console.redhat.com/openshift/cost-management/
+1. For stage, view https://console.stage.redhat.com/openshift/cost-management/
+2. For prod-hccm, view https://console.redhat.com/openshift/cost-management/
 
 ## Release notes
 
-After releasing to prod-stable, a new tag will be created here https://github.com/project-koku/koku-ui/tags. Create a new GitHub release based on this tag -- use the tag label as the "release title".
+After releasing to prod-hccm, a new tag will be created here https://github.com/project-koku/koku-ui/tags. Create a new GitHub release based on this tag -- use the tag label as the "release title".
 
 Note that you may  "Draft a new release", before the latest tag is available, and mark it as a "pre-release" -- don't click "publish release" yet, use "save draft".
 
-Please document any new features and bug fixes available in production and other staging environments. For example, note any features that are only available in stage-beta.
+Please document any new features and bug fixes available in production and other staging environments. For example, note any features that are only available in stage.
 
 For release examples, please see existing releases here https://github.com/project-koku/koku-ui/releases
 

apps/koku-ui-ros/README.md

@@ -1,10 +1,10 @@
-# Koku microfrontend (MFE) with Module Federation
+# ROS UI
 
 [![Apache 2.0][license-badge]](https://github.com/project-koku/koku-ui/blob/main/LICENSE)
 [![CI Status][build-badge]](https://github.com/project-koku/koku-ui/actions/workflows/ci.yml?query=branch%3Amain)
 [![codecov][codecov-badge]](https://codecov.io/gh/project-koku/koku-ui)
 
-React.js app for Cost Management.
+React.js app for Resource Optimization with Module Federation.
 
 User interface is based on [Patternfly].
 
@@ -43,21 +43,21 @@ sudo bash scripts/patch-etc-hosts.sh
 3. Clone the repository, and open a terminal in the base of this project.
 4. Run the command `npm install` to install all the dependencies.
 
-## Building
+## Building apps/koku-ui-ros
 ```
 npm build
 ```
 
-## Testing
+## Testing apps/koku-ui-ros
 ```
 npm test
 ```
 
-## Running Koku MFE against a hosted Koku API, using webpack proxy
+## Running ROS UI against a hosted Koku API, using webpack proxy
 
 Note that this approach currently supports only the Insights stage environment.
 
-1. Start development server
+1. Start development server in apps/koku-ui-ros
 ```
 npm start
 ```
@@ -73,7 +73,7 @@ https://stage.foo.redhat.com:1337/staging/cost-management
 
 Note: Must log in with a user that has Cost Management permissions
 
-### Running Koku MFE with local Cloud Services Backend
+### Running ROS UI with local Cloud Services Backend
 
 Refer to the [serving files locally][serving-files-locally] section of cloud services config for more details
 
@@ -82,26 +82,26 @@ Refer to the [serving files locally][serving-files-locally] section of cloud ser
 make dev-static-node
 ```
 
-2. Start development server in Koku MFE repo
+2. Start development server in apps/koku-ui-ros
 ```
 npm start:csb
 ```
 
-### Running Koku MFE with local Koku UI
+### Running ROS UI with local Koku UI
 
 Refer to the [koku-ui README][koku-ui-readme] for more details
 
-1. Start development server in Koku MFE repo
+1. Start development server in apps/koku-ui-ros
 ```
 npm start:static
 ```
 
-2. Start development server in Koku UI repo
+2. Start development server in apps/koku-ui-hccm
 ```
-npm start:mfe
+npm start:ros
 ```
 
-### Running Koku MFE with local Koku UI and Cloud Services Backend
+### Running ROS UI with local Koku UI and Cloud Services Backend
 
 Refer to the [serving files locally][serving-files-locally] section of cloud services config and the [koku-ui README][koku-ui-readme] for more details
 
@@ -110,19 +110,19 @@ Refer to the [serving files locally][serving-files-locally] section of cloud ser
 make dev-static-node
 ```
 
-2. Start development server in Koku MFE repo
+2. Start development server in apps/koku-ui-ros
 ```
 npm start:static
 ```
 
-3. Start development server in Koku UI repo
+3. Start development server in apps/koku-ui-ros
 ```
-npm start:csb:mfe
+npm start:csb:ros
 ```
 
-## Releasing Koku MFE
+## Releasing ROS UI
 
-This [RELEASE][release-doc] doc describes how to release Koku MFE to each staging environment.
+This [RELEASE][release-doc] doc describes how to release ROS UI to each staging environment.
 
 [build-badge]: https://github.com/project-koku/koku-ui/actions/workflows/ci.yml/badge.svg?branch=main
 [codecov-badge]: https://codecov.io/gh/project-koku/koku-ui/graph/badge.svg?token=1hjFIy1cRe

apps/koku-ui-ros/RELEASE.md

@@ -1,58 +1,46 @@
-# Releasing Koku microfrontend (MFE) with Module Federation
+# Releasing ROS UI
 
-This doc describes how to release Koku MFE to each staging environment. Note that this should be done in order for testing purposes; stage-stable, prod-beta, and finally prod-stable
+This doc describes how to release ROS UI to each staging environment. Note that this should be done in order for testing purposes.
 
 ## Release script
 
 The release script creates a PR with a unique SHA, used for a namespace \`ref\` in the app-interface repo. The script also ensures that code is always pulled from the correct branches. For example, we always:
 
-1. Pull from master when pushing to stage-stable
-2. Pull from stage-stable when pushing to prod-beta
-3. Pull from prod-beta when pushing to prod-stable
+1. Pull from master when pushing to stage-ros
+2. Pull from stage-ros when pushing to prod-ros
 
-Please allow the PR to build successfully and merge before running the script again for the next branch.
+Please allow the PR to build successfully and merge before running the script again.
 
-### Release to stage-stable
+### Release to stage-ros
 
 ```
 sh scripts/release-branch.sh -s
 ```
 
-### Release to prod-beta
+### Release to prod-ros
 
 ```
-sh scripts/release-branch.sh -b
-```
-
-### Release to prod-stable
-
-```
-sh scripts/release-branch.sh -p
+sh scripts/release-branch.sh -r
 ```
 
 ## Deployment
 
-After all PRs have been merged, update the \`hccm-frontend-mfe\` resource in https://gitlab.cee.redhat.com/service/app-interface/-/blob/master/data/services/insights/hccm/deploy-clowder.yml
+After all PRs have been merged, update the \`koku-ui-ros\` resource in https://gitlab.cee.redhat.com/service/app-interface/-/blob/master/data/services/insights/hccm/deploy-clowder.yml
 
 Use the latest commit of each branch to update namespaces \`ref\` in the app-interface repo. Don't use a merge commit, SHAs must be unique when images are created for each branch.
 
 ```
-- name: hccm-frontend-mfe
+- name: koku-ui-ros
   ...
     # Stage Stable Deployment
   - namespace:
       $ref: /services/insights/frontend-operator/namespaces/stage-frontends.yml
-    ref: 68ce48592f5222029f27f6fb708698013d2f0a58 // Replace with latest SHA for stage-beta branch
-    ...
-    # Prod Beta Deployment
-  - namespace:
-      $ref: /services/insights/frontend-operator/namespaces/prod-beta-frontends.yml
-    ref: e2d9e9116068d4d1aa5feda5c7d1716ee02b5bca // Replace with latest SHA for prod-beta branch
+    ref: 68ce48592f5222029f27f6fb708698013d2f0a58 // Replace with latest SHA for stage-ros branch
     ...
     # Prod Stable Deployment
   - namespace:
       $ref: /services/insights/frontend-operator/namespaces/prod-frontends.yml
-    ref: 77deb707f31b40414e8b13afe23d39e7091fd067 // Replace with latest SHA for prod-stable branch
+    ref: 77deb707f31b40414e8b13afe23d39e7091fd067 // Replace with latest SHA for prod-ros branch
     ...
 ```
 
@@ -62,16 +50,16 @@ After releasing to each staging environment, open an incognito window and view o
 
 Please ensure expected changes have been updated before releasing to the next staging environment.
 
-1. For stage-stable, view https://console.stage.redhat.com/staging/cost-management/
-2. For prod-beta, view https://console.redhat.com/beta/staging/cost-management/
+1. For stage-ros, view https://console.stage.redhat.com/staging/cost-management/
+2. For prod-ros, view https://console.redhat.com/staging/cost-management/ (preview mode only)
 
 ## Release notes
 
-After releasing to prod-stable, a new tag will be created here https://github.com/project-koku/koku-ui/tags. Create a new GitHub release based on this tag -- use the tag label as the "release title".
+After releasing to prod-ros, a new tag will be created here https://github.com/project-koku/koku-ui/tags. Create a new GitHub release based on this tag -- use the tag label as the "release title".
 
 Note that you may  "Draft a new release", before the latest tag is available, and mark it as a "pre-release" -- don't click "publish release" yet, use "save draft".
 
-Please document any new features and bug fixes available in production and other staging environments. For example, note any features that are only available in stage-beta.
+Please document any new features and bug fixes available in production and other staging environments. For example, note any features that are only available in stage.
 
 For release examples, please see existing releases here https://github.com/project-koku/koku-ui/releases