doc: restructure directories and add quickstart

Shabirmean commented 2 years ago

Description

This PR is one of the many to come where we re-arrange the directory structure of the repo
Currently the sample application is nested inside a folder called point-of-sale-app from the root of the repo
Ideally we want to bring everything inside that folder to the root of the repo and delete this folder
Also we want to move the anthos-baremetal-edge-deployment ansible scripts to the anthos-samples repository
As a first step I am moving everything inside the point-of-sale-app folder to the top level of the repo whilst this is kept as is
We do this because there are content that is referencing this directory. Once we identify them and update them, we can delete this folder

Changes

Move everything inside the point-of-sale-app folder to the root of the repo
Put all the source code specific directories (api-server, inventory, payments, ui, service-sdk) into a folder called src
Add a new folder called docs at the root which will have all the different guideline docs
Add a new doc to explain the QuickStart for deploying the sample application to a GKE cluster

Files to be reviews:

The many files in this PR are just from moving the files inside point-of-sale-app out into the root directory
So only files that you might have to review are:
- The cloudbuild yaml files in the .github/cloudbuild path
- The README in the root of the repo
- The docs file (quickstart.md) inside the newly created docs folder in the root of the repo
- README changes to anthos-baremetal-edge-deployment/README.md
- Updates to the release-please-config.json file
- A small addition to the .gitignore file
- Update the skaffold.yaml file to have the src/ prefix before the projects

snippet-bot[bot] commented 2 years ago

Here is the summary of changes.

You are about to add 23 region tags.

- [k8-manifests/api-server-lb.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/api-server-lb.yaml#L15), tag `anthosbaremetal_k8_manifests_api_server_lb_service_api_server_lb` - [k8-manifests/dev/api-server.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/dev/api-server.yaml#L15), tag `anthosbaremetal_dev_api_server_deployment_api_server` - [k8-manifests/dev/api-server.yaml:68](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/dev/api-server.yaml#L68), tag `anthosbaremetal_dev_api_server_service_api_server_svc` - [k8-manifests/dev/inventory.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/dev/inventory.yaml#L15), tag `anthosbaremetal_dev_inventory_deployment_inventory` - [k8-manifests/dev/inventory.yaml:73](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/dev/inventory.yaml#L73), tag `anthosbaremetal_dev_inventory_service_inventory_svc` - [k8-manifests/dev/payments.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/dev/payments.yaml#L15), tag `anthosbaremetal_dev_payments_deployment_payments` - [k8-manifests/dev/payments.yaml:63](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/dev/payments.yaml#L63), tag `anthosbaremetal_dev_payments_service_payments_svc` - [k8-manifests/mysql-db.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/mysql-db.yaml#L15), tag `anthosbaremetal_k8_manifests_mysql_db_statefulset_mysql_db` - [k8-manifests/mysql-db.yaml:63](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/mysql-db.yaml#L63), tag `anthosbaremetal_k8_manifests_mysql_db_service_mysql_db` - [k8-manifests/mysql-db.yaml:83](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/mysql-db.yaml#L83), tag `anthosbaremetal_k8_manifests_mysql_db_configmap_mysql_db_mysql_db_config` - [k8-manifests/release/api-server.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/release/api-server.yaml#L15), tag `anthosbaremetal_release_api_server_deployment_api_server` - [k8-manifests/release/api-server.yaml:69](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/release/api-server.yaml#L69), tag `anthosbaremetal_release_api_server_service_api_server_svc` - [k8-manifests/release/inventory.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/release/inventory.yaml#L15), tag `anthosbaremetal_release_inventory_deployment_inventory` - [k8-manifests/release/inventory.yaml:74](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/release/inventory.yaml#L74), tag `anthosbaremetal_release_inventory_service_inventory_svc` - [k8-manifests/release/payments.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/release/payments.yaml#L15), tag `anthosbaremetal_release_payments_deployment_payments` - [k8-manifests/release/payments.yaml:64](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/release/payments.yaml#L64), tag `anthosbaremetal_release_payments_service_payments_svc` - [k8-manifests/service-configs.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/service-configs.yaml#L15), tag `anthosbaremetal_k8_manifests_service_configs_configmap_service_configs` - [k8-manifests/springprofile-h2.yaml:20](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/springprofile-h2.yaml#L20), tag `anthosbaremetal_k8_manifests_springprofile_h2_configmap_spring_profile` - [k8-manifests/springprofile-mysql.yaml:20](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/k8-manifests/springprofile-mysql.yaml#L20), tag `anthosbaremetal_k8_manifests_springprofile_mysql_configmap_spring_profile` - [skaffold.yaml:15](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/skaffold.yaml#L15), tag `anthosbaremetal_skaffold_config_setup` - [skaffold.yaml:26](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/skaffold.yaml#L26), tag `anthosbaremetal_skaffold_config_db` - [skaffold.yaml:44](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/skaffold.yaml#L44), tag `anthosbaremetal_skaffold_config_backend` - [skaffold.yaml:83](https://github.com/GoogleCloudPlatform/point-of-sale/blob/b1703a1256a0352093e90466152e32da24355bb1/skaffold.yaml#L83), tag `anthosbaremetal_skaffold_config_load_balancer`

This comment is generated by snippet-bot. If you find problems with this result, please file an issue at: https://github.com/googleapis/repo-automation-bots/issues. To update this comment, add snippet-bot:force-run label or use the checkbox below:

[ ] Refresh this comment

Shabirmean commented 2 years ago

/gcbrun

Shabirmean commented 2 years ago

:zap: Two deployments have been created for the Point-of-Sale application. You may access and test them at: :zap:

MySQL DB backed deployment: 34.136.23.171
Embedded H2 DB backed deployment: 35.225.234.157

Shabirmean commented 2 years ago

This LGTM based on the description of what needs to be reviewed + my comment + a small clarification:

When you say "moved the PoS app to the root directory" do you mean copy (and not move), since the old directory with its content is still present?

Yes. Sorry, I meant to say copy

Shabirmean commented 2 years ago

:zap: Two deployments have been created for the Point-of-Sale application. You may access and test them at: :zap:

MySQL DB backed deployment: 34.136.23.171
Embedded H2 DB backed deployment: 35.225.234.157

Shabirmean commented 2 years ago

:zap: Two deployments have been created for the Point-of-Sale application. You may access and test them at: :zap:

MySQL DB backed deployment: 34.136.23.171
Embedded H2 DB backed deployment: 35.225.234.157

Shabirmean commented 2 years ago

:zap: Two deployments have been created for the Point-of-Sale application. You may access and test them at: :zap:

MySQL DB backed deployment: 34.136.23.171
Embedded H2 DB backed deployment: 35.225.234.157

GoogleCloudPlatform / point-of-sale