chore(docs): add initial documentation with mkdocs (#3)

* docs(docs): add initial documentation with mkdos

we add the first construct library docs

* chore(docs): update pull request lint workflow

we added the docs type of commit

* fix(docs): the type of semantic pull request name

the syntaxis was wrong because it didn't add the break line

* chore(docs): revert pr lint validation

we have the default PR Title Lint validation

Author: antonio-marquez-perez

.cz-config.js

@@ -24,7 +24,11 @@ module.exports = {
     { value: 'WIP', name: 'WIP:      Work in progress' },
   ],
 
-  scopes: [{ name: 'codestarconnection' }, { name: 'projen' }],
+  scopes: [
+    { name: 'codestarconnection' },
+    { name: 'projen' },
+    { name: 'docs' },
+  ],
 
   usePreparedCommit: true, // to re-use commit from ./.git/COMMIT_EDITMSG
   allowTicketNumber: false,

.gitattributes

@@ -0,0 +1 @@
+v18.17.1

.github/workflows/deploy-docs.yml

@@ -1,5 +1,7 @@
 import { awscdk } from 'projen';
+import { JobPermission } from 'projen/lib/github/workflows-model';
 import { TrailingComma } from 'projen/lib/javascript';
+
 const project = new awscdk.AwsCdkConstructLibrary({
   author: 'Antonio Márquez Pérez',
   authorAddress: '[email protected]',
@@ -24,6 +26,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
       verbose: true,
     },
   },
+  github: true,
   deps: [] /* Runtime dependencies of this module. */,
   peerDeps: [] /* Peer dependencies of this module. */,
   description:
@@ -39,4 +42,59 @@ project.addScripts({
   commit: './node_modules/cz-customizable/standalone.js',
 });
 
+project.addGitIgnore('site');
+
+project.prettier?.addIgnorePattern('*.md');
+
+project.addTask('docs:build', {
+  exec: 'mkdocs build',
+});
+
+project.addTask('docs:serve', {
+  exec: 'mkdocs serve -a localhost:8099',
+});
+
+const deployDocs = project.github?.addWorkflow('deploy-docs');
+deployDocs?.on({
+  workflowDispatch: {},
+  workflowRun: {
+    workflows: ['release'],
+    types: ['completed'],
+  },
+});
+
+deployDocs?.addJob('deploy-docs', {
+  permissions: {
+    contents: JobPermission.WRITE,
+  },
+  runsOn: ['ubuntu-latest'],
+  steps: [
+    {
+      uses: 'actions/checkout@v4',
+    },
+    {
+      uses: 'actions/setup-python@v4',
+      with: {
+        pythonVersion: '3.x',
+      },
+    },
+    {
+      run: 'echo "cache_id=$(date --utc "+%V")" >> $GITHUB_ENV',
+    },
+    {
+      uses: 'actions/cache@v3',
+      with: {
+        key: 'mkdocs-material-${{ env.cache_id }}',
+        path: '.cache',
+      },
+    },
+    {
+      run: 'pip install mkdocs-material',
+    },
+    {
+      run: 'mkdocs gh-deploy --force',
+    },
+  ],
+});
+
 project.synth();

.gitignore

@@ -0,0 +1,23 @@
+# Homepage
+
+This is a AWS CDK Construct Library to create a Code Star Connection.
+
+## Install
+
+You can install this library using the following command
+
+```shell
+yarn add @jttc/aws-codestarconnection
+```
+
+```shell
+npm install @jttc/aws-codestarconnection
+```
+
+## Features
+
+The Construct Library has the following L2 Construct:
+
+| Construct               | Description                                                    |
+|-------------------------|----------------------------------------------------------------|
+| [CodeStarConnection](#) | We create a Code Star Connection for every Provider available  |

.nvmrc

@@ -0,0 +1,60 @@
+site_name: AWS Code Star Connection Construct Library
+repo_url: https://github.com/JumpToTheCloud/aws-codestarconnection
+
+nav:
+  - Homepage:
+      - index.md
+
+theme:
+  name: material
+  font:
+    text: Ubuntu
+  palette:
+    - scheme: default
+      primary: custom
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: custom
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - header.autohide
+    - navigation.sections
+    - navigation.expand
+    - navigation.top
+    - navigation.instant
+    - navigation.indexes
+    - content.code.annotate
+    - content.code.copy
+    - toc.follow
+    - toc.integrate
+    - announce.dismiss
+    - navigation.tabs
+
+extra:
+  version:
+    provider: mike
+    default: latest
+
+plugins:
+  - mike:
+      version_selector: true
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - attr_list
+  - tables
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg