Initial commit

.github/workflows/validate_catalog.yaml

@@ -0,0 +1,22 @@
+#Validation script for Industry-Product-Configurator
+#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/[email protected]'

README.md

@@ -0,0 +1,5 @@
+# Industry-Product-Configurator
+[View this project in Backstage](https://backstage.corp.unity3d.com/catalog/default/component/industry-product-configurator) <br/>
+# Converting to public repository
+Any and all Unity software of any description (including components) (1) whose source is to be made available other than under a Unity source code license or (2) in respect of which a public announcement is to be made concerning its inner workings, may be licensed and released only upon the prior approval of Legal.
+The process for that is to access, complete, and submit this [FORM](https://docs.google.com/forms/d/e/1FAIpQLSe3H6PARLPIkWVjdB_zMvuIuIVtrqNiGlEt1yshkMCmCMirvA/viewform).

catalog-info.yaml

@@ -0,0 +1,18 @@
+# For more information about the available options please visit: http://go/backstage (VPN required)
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  annotations:
+    github.com/project-slug: Unity-Technologies/Industry-Product-Configurator
+    backstage.io/techdocs-ref: dir:.
+  name: Industry-Product-Configurator
+  description: "This is a light weight product configurator framework that supports Visibility, Material and transform variants"
+  labels:
+    costcenter: "2105"
+  tags:
+    - planned-public
+    - enterprise
+spec:
+  type: library
+  lifecycle: production
+  owner: unity-technologies/industry-cse

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.
+

docs/index.md

@@ -0,0 +1,12 @@
+# TechDocs space for Industry-Product-Configurator 
+
+!!! 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](https://docs.unityops.net/unity-backstage/users/techdocs/) 
+
+### If you are viewing this page in Backstage 
+
+To update this file, see `docs/index.md` in your repo.  
+
+### If you are viewing this page in GitHub 
+
+View this documentation rendered in Backstage [here](https://backstage.corp.unity3d.com/catalog/default/component/Industry-Product-Configurator/docs).

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.
+

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.
+

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).
+

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]
+		

mkdocs.yml

@@ -0,0 +1,17 @@
+# This file was added for TechDocs with Unity Backstage https://docs.unityops.net/unity-backstage/users/techdocs/
+# For more information on the configuration below see https://www.mkdocs.org/user-guide/configuration/
+site_name: Industry-Product-Configurator
+repo_url: https://github.com/Unity-Technologies/Industry-Product-Configurator
+repo_name: GitHub
+docs_dir: docs
+edit_uri: "edit/main/docs/"
+strict: true
+plugins:
+  - techdocs-core
+nav:
+  - About TechDocs: "index.md"
+  - Introduction to Industry-Product-Configurator: "intro.md"
+  - Architecture and design: "design.md"
+  - Installing for local development: "installation.md"
+  - Troubleshooting: "troubleshooting.md"
+  - Runbook: "runbook.md"