Initial commit

unity-at-github · unity-at-github · commit 53df56c911b7 · 2025-11-04T16:34:20.000+01:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,2 @@
+# see https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners for more information
+* @Unity-Technologies/ind-proj-orca-admins
diff --git a/.github/workflows/validate_catalog.yaml b/.github/workflows/validate_catalog.yaml
@@ -0,0 +1,22 @@
+#Validation script for immersive-commerce-walmart-relay
+#This is used to validate your catalog-info.yaml 
+
+name: Validate Catalog-info.yaml
+on:
+  pull_request:
+    paths:
+      - 'catalog-info.yaml'
+  push:
+    paths:
+      - 'catalog-info.yaml'
+    branches: [main]
+
+jobs:
+  validate_catalog:
+    runs-on: ubuntu-latest
+    steps:
+      - id: 'Checkout'
+        uses: actions/checkout@v3
+
+      - id: 'Validate'
+        uses: 'RoadieHQ/backstage-entity-validator@v0.3.2'
diff --git a/README.md b/README.md
@@ -0,0 +1,2 @@
+# immersive-commerce-walmart-relay
+[View this project in Unity Internal Developer Portal](https://developer.portal.internal.unity.com/catalog/default/component/immersive-commerce-walmart-relay) <br/>
diff --git a/catalog-info.yaml b/catalog-info.yaml
@@ -0,0 +1,15 @@
+# For more information about the available options please visit: http://go/catalog-info (VPN required)
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  annotations:
+    github.com/project-slug: Unity-Technologies/immersive-commerce-walmart-relay
+    backstage.io/techdocs-ref: dir:.
+  name: immersive-commerce-walmart-relay
+  description: "Walmart Immersive Commerce Authentication Relay Service reference implementation for AccountLinking&Checkout"
+  labels:
+    costcenter: "7052"
+spec:
+  type: service
+  lifecycle: pre-production
+  owner: Unity-Technologies/ind-proj-orca-admins
diff --git a/docs/design.md b/docs/design.md
@@ -0,0 +1,18 @@
+# Installing [tool/service] for local development
+
+## Prerequisites
+
+List here anything that developers need to have installed or set up before they start installing your tool/service.
+
+## Installation steps
+
+Use an ordered list to tell developers what they need to do to install your tool/service.
+
+1. Clone [tool/service repo](put a link here)
+2. Run [some command]
+3. Run [some other command]
+
+## Checking installation
+
+Describe a basic command or procedure developers can run to check that everything's installed as it should.
+	
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,12 @@
+# TechDocs space for immersive-commerce-walmart-relay 
+
+!!! note
+    This repo has been pre-populated by RepoDB with a skeleton to get your documentation started.  More information on TechDocs used at Unity can be found [here](http://go/docs-techdocs) 
+
+### If you are viewing this page in Unity Internal Developer Portal 
+
+To update this file, see `docs/index.md` in your repo.  
+
+### If you are viewing this page in GitHub 
+
+View this documentation rendered in Unity Internal Developer Portal [here](https://developer.portal.internal.unity.com/catalog/default/component/immersive-commerce-walmart-relay/docs).
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1,18 @@
+# Installing [tool/service] for local development
+
+## Prerequisites
+
+List here anything that developers need to have installed or set up before they start installing your tool/service.
+
+## Installation steps
+
+Use an ordered list to tell developers what they need to do to install your tool/service.
+
+1. Clone [tool/service repo](put a link here)
+2. Run [some command]
+3. Run [some other command]
+
+## Checking installation
+
+Describe a basic command or procedure developers can run to check that everything's installed as it should.
+	
diff --git a/docs/intro.md b/docs/intro.md
@@ -0,0 +1,20 @@
+# Introduction to [tool/service]
+
+Describe your tool or service in a couple of sentences. What does it do, in the broadest terms?
+
+## How [tool/service] works
+
+A bit more detail here about how your tool/service works. What technologies does it use, how do they interact?
+
+> Example: [tool/service] uses [technology A] to connect [technology B] with [technology C] so that [problem tool/service solves].
+
+## Intended use case
+
+Describe the intended use case for your tool or service, including the user groups it's aimed at and what they want to achieve with it.
+
+> Example: [tool/service] allows users to [do a cool thing they couldn't otherwise], and can be used by [user persona/role] and [other user persona/role].
+
+## Support
+
+Who can readers of this doc contact for more information or support? Ideally link to a Slack channel, rather than individuals.
+		
diff --git a/docs/runbook.md b/docs/runbook.md
@@ -0,0 +1,4 @@
+# Runbook
+
+If you want a high tier of support from SRE for your tool/service, then you'll need to provide a runbook for them. You can see their template runbook [here](https://github.com/Unity-Technologies/pre-sre-runbook-template).
+		
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -0,0 +1,17 @@
+# Troubleshooting
+
+Use this page to describe troubleshooting procedures for common problems during local development.
+
+## General issues
+
+List a selection of steps to take for any non-specific issues.
+
+* Uninstall and reinstall
+* Update to the latest version
+
+## [Specific error message]
+
+If you have issues that always occur with a specific error message, list them on this page under a heading with the error message itself, so developers can quickly identify what steps they need to take.
+
+## [Other specific error message]
+		
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,17 @@
+# This file was added for TechDocs in Unity Internal Developer Portal http://go/docs-techdocs
+# For more information on the configuration below see https://www.mkdocs.org/user-guide/configuration/
+site_name: immersive-commerce-walmart-relay
+repo_url: https://github.com/Unity-Technologies/immersive-commerce-walmart-relay
+repo_name: GitHub
+docs_dir: docs
+edit_uri: "edit/main/docs/"
+strict: true
+plugins:
+  - techdocs-core
+nav:
+  - About TechDocs: "index.md"
+  - Introduction to immersive-commerce-walmart-relay: "intro.md"
+  - Architecture and design: "design.md"
+  - Installing for local development: "installation.md"
+  - Troubleshooting: "troubleshooting.md"
+  - Runbook: "runbook.md"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# see https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners for more information`
	`2`	`+* @Unity-Technologies/ind-proj-orca-admins`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# immersive-commerce-walmart-relay`
	`2`	`+[View this project in Unity Internal Developer Portal](https://developer.portal.internal.unity.com/catalog/default/component/immersive-commerce-walmart-relay) <br/>`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +# Runbook
++
 +If you want a high tier of support from SRE for your tool/service, then you'll need to provide a runbook for them. You can see their template runbook [here](https://github.com/Unity-Technologies/pre-sre-runbook-template).
++