Adding mkdocs files wherever necessary and correcting names

catalog/systems/mkdocs.yml

@@ -1,4 +1,13 @@
 site_name: 'One Platform'
 
+nav:
+  - What's One Platform: overview.md
+  - One Platform Architecture: op-architecture.md
+  - OP Service Deployment Guideline: service-deployment-guideline.md
+  - SPA Deployment Guideline: spa-deployment-guidelines.md
+  - How to Contribute: how-to-contribute.md
+  - Code Of Conduct: code-of-conduct.md
+
+
 plugins:
   - techdocs-core

packages/analytics-service/docs/index.md

@@ -1,4 +1,4 @@
-# analytics Microservice
+# Analytics Microservice
 
 Analytics microservice is used for providing analytics api information for SPAs deployed in One Platform by connecting with Sentry and Pendo
 

packages/api-catalog-spa/catalog-info.yml

@@ -9,7 +9,6 @@ metadata:
   annotations:
     lighthouse.com/website-url: https://one.redhat.com/developers/api-catalog
     github.com/project-slug: '1-Platform/one-platform'
-    backstage.io/techdocs-ref: dir:.
     servicenow.com/appcode: ONEP-007
     spaship.io/property-id: 'one-platform'
     spaship.io/app-id: 'op-api-catalog'

packages/api-gateway-service/mkdocs.yml

@@ -1,4 +1,4 @@
-site_name: 'Analytics Service'
+site_name: 'API Gateway Service'
 
 nav:
   - Getting Started: index.md

packages/apps-service/docs/index.md

@@ -0,0 +1,49 @@
+# Apps Microservice
+
+Apps Microservice provides the essential GraphQL APIs required for the Developer Console. It provides graphql queries for creating and managing apps.
+
+## Features
+
+- Allows creation of apps/projects
+- Allows configuration of databases (Requires a couchdb instance)
+
+## Local Development
+
+### 1. Switch to the working directory
+
+1. Switch to the working directory `cd apps-service`
+2. Copy the `.env.example` to the `.env`
+3. Change the values as needed, keeping the unneeded values as undefined
+
+### 2. Start Microservice
+
+Run `npm start` to run your microservice for dev env
+
+To build the microservice, use `npm run build`.
+
+## Using docker-compose (Recommended)
+
+1. Follow the first 2 steps from above
+2. Then execute the following command to start a standalone instance of `apps-service`
+
+   ```bash
+   docker-compose up -d apps-service
+   ```
+
+   **Note:** Some features of the App Service might not work without the API Gateway.
+
+3. To start the entire cluster of microservices, use the following command
+
+   ```bash
+   docker-compose up -d api-gateway
+   ```
+
+## Runnninng Tests
+
+```bash
+npm test
+```
+
+## Contributors:
+
+👤 **Mayur Deshmukh** [@deshmukhmayur](https://github.com/deshmukhmayur)

packages/component-catalog-spa/docs/index.md

@@ -0,0 +1,51 @@
+---
+id: component-lib-overview
+title: OP Components
+slug: /op-components
+sidebar_label: Overview
+---
+
+One platform component library is a collection of web components which are built using lit-element, each component following the red hat brand guideline. LitElement follows the Web Components standards, so your components will work with any framework.
+
+## Guides
+
+### Component creation
+
+1. Go to `https://github.com/1-Platform/op-components` and fork this repository
+
+2. Clone the forked repository
+
+```sh
+git clone git@github.com:1-Platform/op-components.git
+```
+
+3. Install Packages
+
+```sh
+npm i
+```
+
+4. To create a new package run
+
+```sh
+npm run new
+```
+
+5. Alternatively to run a component
+
+```sh
+npm run dev <component-name>
+```
+
+6. OP-Styles
+
+Which includes the common style, which can be used in other components.
+Documentation Link
+
+### Quick Start Guide
+
+To Use the component from the library go packages into GitHub Repo or its corresponding [npm package](https://1-platform.github.io/op-components).
+
+All of the packages are published on [npmjs](https://www.npmjs.com/org/one-platform)
+
+The usage for all of the components is mentioned in their respective README, which is also available on npmjs. [(example)](https://www.npmjs.com/package/@one-platform/opc-footer)

packages/component-catalog-spa/mkdocs.yml

@@ -0,0 +1,6 @@
+site_name: 'Component Catalog'
+
+nav:
+  - Getting Started: index.md
+plugins:
+  - techdocs-core

packages/developer-console-spa/catalog-info.yml

@@ -9,7 +9,6 @@ metadata:
   annotations:
     lighthouse.com/website-url: https://one.redhat.com/console
     github.com/project-slug: '1-Platform/one-platform'
-    backstage.io/techdocs-ref: dir:.
     servicenow.com/appcode: ONEP-001
     spaship.io/property-id: 'one-platform'
     spaship.io/app-id: 'developer-console'

packages/doc-spa/catalog-info.yml

@@ -9,7 +9,6 @@ metadata:
   annotations:
     lighthouse.com/website-url: https://one.redhat.com/get-started
     github.com/project-slug: '1-Platform/one-platform'
-    backstage.io/techdocs-ref: dir:.
     servicenow.com/appcode: ONEP-001
     spaship.io/property-id: 'one-platform'
     spaship.io/app-id: 'op-docs'

packages/feedback-spa/catalog-info.yml

@@ -9,7 +9,6 @@ metadata:
   annotations:
     lighthouse.com/website-url: https://one.redhat.com/feedback
     github.com/project-slug: '1-Platform/one-platform'
-    backstage.io/techdocs-ref: dir:.
     servicenow.com/appcode: ONEP-004
     spaship.io/property-id: 'one-platform'
     spaship.io/app-id: 'developer-console'

packages/home-spa/catalog-info.yml

@@ -9,7 +9,6 @@ metadata:
   annotations:
     lighthouse.com/website-url: https://one.redhat.com
     github.com/project-slug: '1-Platform/one-platform'
-    backstage.io/techdocs-ref: dir:.
     servicenow.com/appcode: ONEP-001
     spaship.io/property-id: 'one-platform'
     spaship.io/app-id: 'home-spa'

packages/lighthouse-spa/catalog-info.yml

@@ -9,7 +9,6 @@ metadata:
   annotations:
     lighthouse.com/website-url: https://one.redhat.com/lighthouse
     github.com/project-slug: '1-Platform/one-platform'
-    backstage.io/techdocs-ref: dir:.
     servicenow.com/appcode: ONEP-008
     spaship.io/property-id: 'one-platform'
     spaship.io/app-id: 'lighthouse-spa'

packages/reverse-proxy-service/docs/index.md

@@ -0,0 +1,13 @@
+# Reverse Proxy
+
+A simple express server that acts as a reverse-proxy/authentication layer for some internal services and APIs.
+
+Currently, the reverse-proxy contains middleware rules for:
+
+- CouchDB: An open-source document-oriented NoSQL database.
+- Keycloak Auth: An auth middleware to apply Keycloak SSO Auth to some restricted URLs
+- A no-cors proxy middleware: Used for API Catalog
+
+## License
+
+This sub-package, like it's parent monorepository, is licensed under [MIT License](../../LICENSE).

packages/reverse-proxy-service/mkdocs.yml

@@ -0,0 +1,7 @@
+site_name: 'Analytics Service'
+
+nav:
+  - Getting Started: index.md
+
+plugins:
+  - techdocs-core

packages/search-spa/catalog-info.yml

@@ -9,7 +9,6 @@ metadata:
   annotations:
     lighthouse.com/website-url: https://one.redhat.com/search
     github.com/project-slug: '1-Platform/one-platform'
-    backstage.io/techdocs-ref: dir:.
     servicenow.com/appcode: ONEP-001
     spaship.io/property-id: 'one-platform'
     spaship.io/app-id: 'search'