setup the docs base (#177)

* created the template for the official documentation

* setting up the environment

* cleaned up the documentation setup

* adjusted the color scheme

* setup the basic pages for the tirith documentation

* updated the intro page

documentation/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

documentation/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

documentation/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

documentation/docs/getting-started-with-tirith.md

@@ -0,0 +1,51 @@
+---
+id: getting-started-with-tirith
+title: Getting started with Tirith
+sidebar_label: Getting Started 
+description: This documentation overviews you about the introduction of the tirith software.
+keywords:
+  - tirith
+  - stack-guardian
+# url: https://www.lambdatest.com/support/docs/getting-started-with-tirith
+site_name: Tirith
+slug: getting-started-with-tirith/
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<script type="application/ld+json"
+  dangerouslySetInnerHTML={{ __html: JSON.stringify({
+   "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    "itemListElement": [{
+      "@type": "ListItem",
+      "position": 1,
+      "name": "Home",
+      "item": "https://www.lambdatest.com"
+    },{
+      "@type": "ListItem",
+      "position": 2,
+      "name": "Support",
+      "item": "https://www.lambdatest.com/support/docs/"
+    },{
+      "@type": "ListItem",
+      "position": 3,
+      "name": "Getting Started With Tirith",
+      "item": "https://www.lambdatest.com/support/docs/getting-started-with-tirith/"
+    }]
+  })
+}}></script>
+Tirith is a robust policy framework designed to automate and enforce security, governance, and compliance across infrastructure-as-code (IaC) platforms like Terraform, CloudFormation, and Kubernetes. It simplifies policy creation and management, ensuring infrastructure adheres to industry regulations and best practices.
+
+## Key Benefits of Tirith
+
+- **Centralized Policy Management :** Tirith offers a unified platform for centralized policy management, reducing duplication and streamlining governance across multiple infrastructures and environments. This ensures consistent application of policies, regardless of the platform being used.
+
+- **Simplified Policy Creation :** Tirith’s [intuitive, no-code interface](https://tirith-policy-builder.vercel.app/) and declarative language simplify policy authoring, enabling users to define and manage policies effortlessly. This removes the need for deep technical expertise, allowing teams to quickly align with evolving regulatory requirements.
+
+- **Proactive Compliance Enforcement :** With seamless CI/CD pipeline integration, Tirith proactively enforces compliance by running pre-deployment checks. This ensures non-compliant infrastructure configurations are detected and resolved before deployment, enhancing operational efficiency.
+
+- **Integration with Popular Tools :** Tirith integrates with popular infrastructure-as-code (IaC) tools like Terraform, CloudFormation, and Kubernetes, making it easy to incorporate into your existing workflows.
+
+- **Enhanced Security :** By enforcing consistent policies across your infrastructure, Tirith helps to reduce the risk of security vulnerabilities and compliance violations.

documentation/docs/install-tirith-on-linux.md

@@ -0,0 +1,38 @@
+---
+id: install-tirith-on-linux
+title: Install Tirith on linux
+sidebar_label: Linux
+description: This documentation overviews you about the introduction of the tirith software.
+keywords:
+  - tirith
+  - stack-guardian
+# url: https://www.lambdatest.com/support/docs/getting-started-with-tirith
+site_name: Tirith
+slug: install-tirith-on-linux/
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<script type="application/ld+json"
+  dangerouslySetInnerHTML={{ __html: JSON.stringify({
+   "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    "itemListElement": [{
+      "@type": "ListItem",
+      "position": 1,
+      "name": "Home",
+      "item": "https://www.lambdatest.com"
+    },{
+      "@type": "ListItem",
+      "position": 2,
+      "name": "Support",
+      "item": "https://www.lambdatest.com/support/docs/"
+    },{
+      "@type": "ListItem",
+      "position": 3,
+      "name": "Installation",
+      "item": "https://www.lambdatest.com/support/docs/install-tirith-on-linux/"
+    }]
+  })
+}}></script>

documentation/docs/install-tirith-on-mac.md

@@ -0,0 +1,38 @@
+---
+id: install-tirith-on-mac
+title: Install Tirith on macOS
+sidebar_label: macOS
+description: This documentation overviews you about the introduction of the tirith software.
+keywords:
+  - tirith
+  - stack-guardian
+# url: https://www.lambdatest.com/support/docs/getting-started-with-tirith
+site_name: Tirith
+slug: install-tirith-on-mac/
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<script type="application/ld+json"
+  dangerouslySetInnerHTML={{ __html: JSON.stringify({
+   "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    "itemListElement": [{
+      "@type": "ListItem",
+      "position": 1,
+      "name": "Home",
+      "item": "https://www.lambdatest.com"
+    },{
+      "@type": "ListItem",
+      "position": 2,
+      "name": "Support",
+      "item": "https://www.lambdatest.com/support/docs/"
+    },{
+      "@type": "ListItem",
+      "position": 3,
+      "name": "Installation",
+      "item": "https://www.lambdatest.com/support/docs/install-tirith-on-mac/"
+    }]
+  })
+}}></script>

documentation/docs/install-tirith-on-windows.md

@@ -0,0 +1,38 @@
+---
+id: install-tirith-on-windows
+title: Install Tirith on Windows
+sidebar_label: Windows
+description: This documentation overviews you about the introduction of the tirith software.
+keywords:
+  - tirith
+  - stack-guardian
+# url: https://www.lambdatest.com/support/docs/getting-started-with-tirith
+site_name: Tirith
+slug: install-tirith-on-windows/
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<script type="application/ld+json"
+  dangerouslySetInnerHTML={{ __html: JSON.stringify({
+   "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    "itemListElement": [{
+      "@type": "ListItem",
+      "position": 1,
+      "name": "Home",
+      "item": "https://www.lambdatest.com"
+    },{
+      "@type": "ListItem",
+      "position": 2,
+      "name": "Support",
+      "item": "https://www.lambdatest.com/support/docs/"
+    },{
+      "@type": "ListItem",
+      "position": 3,
+      "name": "Installation",
+      "item": "https://www.lambdatest.com/support/docs/install-tirith-on-windows/"
+    }]
+  })
+}}></script>

documentation/docs/tirith-policy-conditions.md

@@ -0,0 +1,38 @@
+---
+id: tirith-policy-conditions
+title: Policy Conditions
+sidebar_label: Policy Conditions
+description: This documentation overviews you about the introduction of the tirith software.
+keywords:
+  - tirith
+  - stack-guardian
+# url: https://www.lambdatest.com/support/docs/getting-started-with-tirith
+site_name: Tirith
+slug: tirith-policy-conditions/
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<script type="application/ld+json"
+  dangerouslySetInnerHTML={{ __html: JSON.stringify({
+   "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    "itemListElement": [{
+      "@type": "ListItem",
+      "position": 1,
+      "name": "Home",
+      "item": "https://www.lambdatest.com"
+    },{
+      "@type": "ListItem",
+      "position": 2,
+      "name": "Support",
+      "item": "https://www.lambdatest.com/support/docs/"
+    },{
+      "@type": "ListItem",
+      "position": 3,
+      "name": "Tirith Policies",
+      "item": "https://www.lambdatest.com/support/docs/tirith-policy-conditions/"
+    }]
+  })
+}}></script>

documentation/docs/tirith-policy-error-tolerance.md

@@ -0,0 +1,38 @@
+---
+id: tirith-policy-error-tolerance
+title: Error Tolerance
+sidebar_label: Error Tolerance
+description: This documentation overviews you about the introduction of the tirith software.
+keywords:
+  - tirith
+  - stack-guardian
+# url: https://www.lambdatest.com/support/docs/getting-started-with-tirith
+site_name: Tirith
+slug: tirith-policy-error-tolerance/
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<script type="application/ld+json"
+  dangerouslySetInnerHTML={{ __html: JSON.stringify({
+   "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    "itemListElement": [{
+      "@type": "ListItem",
+      "position": 1,
+      "name": "Home",
+      "item": "https://www.lambdatest.com"
+    },{
+      "@type": "ListItem",
+      "position": 2,
+      "name": "Support",
+      "item": "https://www.lambdatest.com/support/docs/"
+    },{
+      "@type": "ListItem",
+      "position": 3,
+      "name": "Tirith Policies",
+      "item": "https://www.lambdatest.com/support/docs/tirith-policy-error-tolerance/"
+    }]
+  })
+}}></script>

documentation/docs/tirith-policy-examples.md

@@ -0,0 +1,38 @@
+---
+id: tirith-policy-examples
+title: Example Policies
+sidebar_label: Example Policies
+description: This documentation overviews you about the introduction of the tirith software.
+keywords:
+  - tirith
+  - stack-guardian
+# url: https://www.lambdatest.com/support/docs/getting-started-with-tirith
+site_name: Tirith
+slug: tirith-policy-examples/
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<script type="application/ld+json"
+  dangerouslySetInnerHTML={{ __html: JSON.stringify({
+   "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    "itemListElement": [{
+      "@type": "ListItem",
+      "position": 1,
+      "name": "Home",
+      "item": "https://www.lambdatest.com"
+    },{
+      "@type": "ListItem",
+      "position": 2,
+      "name": "Support",
+      "item": "https://www.lambdatest.com/support/docs/"
+    },{
+      "@type": "ListItem",
+      "position": 3,
+      "name": "Tirith Policies",
+      "item": "https://www.lambdatest.com/support/docs/tirith-policy-examples/"
+    }]
+  })
+}}></script>

documentation/docs/tirith-policy-structure.md

@@ -0,0 +1,38 @@
+---
+id: tirith-policy-structure
+title: Policy Structure
+sidebar_label: Policy Structure
+description: This documentation overviews you about the introduction of the tirith software.
+keywords:
+  - tirith
+  - stack-guardian
+# url: https://www.lambdatest.com/support/docs/getting-started-with-tirith
+site_name: Tirith
+slug: tirith-policy-structure/
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<script type="application/ld+json"
+  dangerouslySetInnerHTML={{ __html: JSON.stringify({
+   "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    "itemListElement": [{
+      "@type": "ListItem",
+      "position": 1,
+      "name": "Home",
+      "item": "https://www.lambdatest.com"
+    },{
+      "@type": "ListItem",
+      "position": 2,
+      "name": "Support",
+      "item": "https://www.lambdatest.com/support/docs/"
+    },{
+      "@type": "ListItem",
+      "position": 3,
+      "name": "Tirith Policies",
+      "item": "https://www.lambdatest.com/support/docs/tirith-policy-structure/"
+    }]
+  })
+}}></script>