commit

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

README.md

@@ -1 +1,40 @@
-# docs
+# Website
+
+
+### 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.

babel.config.js

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

docs/quickstart/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Quickstart",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "5 minutes to learn the most important Codety concepts."
+  }
+}

docs/quickstart/bitbucket.md

@@ -0,0 +1,22 @@
+---
+title: Quickstart with Bitbucket
+tags: [codety]
+---
+
+Create Bitbucket Workflow referring below example:
+```yaml
+# bitbucket-pipelines.yml
+image: codetyio/codety:latest
+
+pipelines:
+  pull-requests:
+    '**':
+      - step:
+          clone:
+            enabled: true
+          script:
+            - codety
+
+
+```
+The Codety Analyzer will be triggered when there's a new pull request been created or updated. 

docs/quickstart/circleci.md

@@ -0,0 +1,26 @@
+---
+title: Quickstart with CircleCI
+tags: [codety]
+---
+
+Create GitLab CI Workflow referring below example:
+```yaml
+# .circleci/config.yml
+version: 2.1
+jobs:
+  codety-runner:
+    docker:
+      - image: codetyio/codety
+    steps:
+      - checkout
+      - run:
+          command: codety
+
+workflows:
+  build-and-test:
+    jobs:
+      - codety-runner
+
+
+```
+The Codety Analyzer will be triggered when there's a new pull request been created or updated. 

docs/quickstart/github-actions.md

@@ -0,0 +1,30 @@
+---
+title: Quickstart with GitHub Actions
+tags: [codety]
+---
+
+Create GitHub Actions workflow referring below example:
+```yaml
+# .github/workflows/codety.yaml
+name: Codety
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "**" ]
+jobs:
+  Codety_Static_Code_Analysis:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: read
+    container:
+      image: codetyio/codety
+    steps:
+      - uses: actions/checkout@main
+      - run: codety
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+```
+The Codety Analyzer will be triggered when there's a new pull request been created or updated. 

docs/quickstart/gitlab-ci.md

@@ -0,0 +1,21 @@
+---
+title: Quickstart with GitLab CI
+tags: [codety]
+---
+
+Create GitLab CI Workflow referring below example:
+```yaml
+# .gitlab-ci.yml
+stages:
+  - codety
+
+job_build:
+  stage: test
+  image:
+      name: codetyio/codety:latest
+  script:
+    - codety
+
+
+```
+The Codety Analyzer will be triggered when there's a new pull request been created or updated. 

docs/quickstart/harness-ci.md

@@ -0,0 +1,35 @@
+---
+title: Quickstart with Harness CI
+tags: [codety]
+---
+
+Create Harness CI Workflow with below settings:
+```yaml
+# bitbucket-pipelines.yml
+- stage:
+    name: CodetyStage
+    identifier: CodetyAnalyzerStage
+    description: ""
+    type: CI
+    spec:
+      cloneCodebase: true
+      platform:
+        os: Linux
+        arch: Amd64
+      runtime:
+        type: Cloud
+        spec: {}
+      execution:
+        steps:
+          - step:
+              type: Run
+              name: Codety Analyzer
+              identifier: CodetyAnalyzer
+              spec:
+                connectorRef: account.harnessImage
+                image: codetyio/codety
+                shell: Sh
+                imagePullPolicy: Always
+
+```
+The Codety Analyzer will be triggered when there's a new pull request been created or updated. 

docs/quickstart/index.md

@@ -0,0 +1,35 @@
+---
+sidebar_position: 1
+---
+
+# Codety Quickstart
+
+
+Let's discover Codety in less than 5 minutes.
+
+### Overview
+
+:::tip tip
+
+This guide allows you to run static code analysis using Codety Analyzer for your code repository with default settings.
+
+:::
+
+|                                                              | Create Codety Account | Codety Access Token | Deploy Codety Product |
+|--------------------------------------------------------------|-----------------------|---------------------|-----------------------|
+| vvvvvvvvvvvvvvvvvv <br/> **Codety QuickStart** <br/> ^^^^^^^^^^^^^^^ | Not Required          | Not Required        | Not Required          |
+| Codety Cloud-Hosted                                          | Required            | Required          | Not Required          |
+| Codety Self-Hosted                                           | Required            | Required          | Required            |
+
+Get started by using Codety Analyzer container image with your CI/CD pipeline directly.
+
+### Start using it
+* [Quickstart with GitHub Actions](github-actions)
+* [Quickstart with GitLab CI](gitlab-ci)
+* [Quickstart with Harness CI](harness-ci)
+* [Quickstart with Circle CI](circleci)
+* [Quickstart with Bitbucket CI](bitbucket)
+
+### Next step
+
+You can start exploring Codety Cloud-Hosted or Self-Hosted solution for having fine-tuned code analysis settings along with more features.

docusaurus.config.js

@@ -0,0 +1,138 @@
+// @ts-check
+// `@type` JSDoc annotations allow editor autocompletion and type checking
+// (when paired with `@ts-check`).
+// There are various equivalent ways to declare your Docusaurus config.
+// See: https://docusaurus.io/docs/api/docusaurus-config
+
+import {themes as prismThemes} from 'prism-react-renderer';
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'Codety Developer Hub',
+  tagline: 'Adopt code quality standards for your team',
+  favicon: 'img/favicon.ico',
+
+  // Set the production url of your site here
+  url: 'https://docs.codety.io',
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<projectName>/'
+  baseUrl: '/',
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
+  organizationName: 'codetyio', // Usually your GitHub org/user name.
+  projectName: 'codety-developer-hub', // Usually your repo name.
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  // Even if you don't use internationalization, you can use this field to set
+  // useful metadata like html lang. For example, if your site is Chinese, you
+  // may want to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          sidebarPath: './sidebars.js',
+          // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
+          editUrl:
+            'https://github.com/codetyio/codety-developer-hub',
+        },
+        blog: {
+          showReadingTime: true,
+          path: 'release-notes',
+          routeBasePath: 'release-notes',
+          blogSidebarCount: 'ALL',
+          // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
+          editUrl:
+            'https://github.com/codetyio/codety-developer-hub',
+        },
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      // Replace with your project's social card
+      image: 'img/docusaurus-social-card.jpg',
+      navbar: {
+        title: 'Codety Developer Hub',
+        logo: {
+          alt: 'Codety Developer Hub Logo',
+          src: 'img/logo.png',
+        },
+        items: [
+          {
+            type: 'docSidebar',
+            sidebarId: 'tutorialSidebar',
+            position: 'left',
+            label: 'Documentation',
+          },
+          {to: '/release-notes', label: 'Release Notes', position: 'left'},
+          {
+            href: 'https://codety.io',
+            label: 'Codety Website',
+            position: 'right',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Docs',
+            items: [
+              {
+                label: 'Documentation',
+                to: '/docs/quickstart',
+              },
+            ],
+          },
+          {
+            title: 'Links',
+            items: [
+              {
+                label: 'Codety Website',
+                href: 'https://codety.io',
+              },
+              {
+                label: 'Codety Docker Image',
+                href: 'https://hub.docker.com/r/codetyio/codety',
+              },
+
+            ],
+          },
+          {
+            title: 'More',
+            items: [
+              {
+                label: 'Release Log',
+                to: '/release-notes',
+              },
+
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} Codety.`,
+      },
+      prism: {
+        theme: prismThemes.github,
+        darkTheme: prismThemes.dracula,
+      },
+    }),
+};
+
+export default config;