Merge pull request #17 from AtomicXtreme/3.0

Added documentation for dot-doctrine-metadata

.github/workflows/continuous-integration.yml

@@ -0,0 +1,11 @@
+name: "Continuous Integration"
+
+on:
+  pull_request:
+  push:
+    branches:
+    tags:
+
+jobs:
+  ci:
+    uses: laminas/workflow-continuous-integration/.github/workflows/[email protected]

.github/workflows/docs-build.yml

@@ -0,0 +1,16 @@
+name: docs-build
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build Docs
+        uses: dotkernel/documentation-theme/github-actions/docs@main
+        env:
+          DEPLOY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -19,7 +19,7 @@
 [![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-doctrine-metadata)](https://github.com/dotkernel/dot-doctrine-metadata/stargazers)
 [![GitHub license](https://img.shields.io/github/license/dotkernel/dot-doctrine-metadata)](https://github.com/dotkernel/dot-doctrine-metadata/blob/3.0/LICENSE)
 
-[![Build Static](https://github.com/dotkernel/dot-doctrine-metadata/actions/workflows/static-analysis.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-doctrine-metadata/actions/workflows/static-analysis.yml)
+[![Build Static](https://github.com/dotkernel/dot-doctrine-metadata/actions/workflows/continuous-integration.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-doctrine-metadata/actions/workflows/continuous-integration.yml)
 [![codecov](https://codecov.io/gh/dotkernel/dot-doctrine-metadata/graph/badge.svg?token=ZGR8LJGZV5)](https://codecov.io/gh/dotkernel/dot-doctrine-metadata)
 
 [![SymfonyInsight](https://insight.symfony.com/projects/e76bb03b-b630-4a3e-9a24-b6a04cee7210/big.svg)](https://insight.symfony.com/projects/e76bb03b-b630-4a3e-9a24-b6a04cee7210)
@@ -28,40 +28,36 @@
 Provides metadata and strategies for extracting and rendering Doctrine entities.
 This package is a wrapper for `mezzio/mezzio-hal` which addresses the doctrine entity proxy metadata issue when using `mezzio/mezzio-hal` to generate HAL responses.
 
-### Requirements
+## Requirements
+
 - PHP >= 8.1
 - mezzio/mezzio-hal >= ^2.4
 
-### Installation
+## Installation
 
-Run the following command in your project root directory
+Run the following command in your project root directory:
 
-```
-$ composer require dotkernel/dot-doctrine-metadata
-``` 
+      composer require dotkernel/dot-doctrine-metadata
 
-Next, register the package's `ConfigProvider` to your application config.
+Next, register the package's `ConfigProvider` to your application config:
 
-``Dot\DoctrineMetadata\ConfigProvider::class,``
+      Dot\DoctrineMetadata\ConfigProvider::class,
 
 Note : Make sure to register the package in the `// DK packages` section.
 
-### Migrating from previous integrations
+## Migrating from previous integrations
 
 To migrate from previous integrations please follow the below steps, in order:
 
 - Remove the previous fork from composer.json at the `repositories` key :
-```$xslt
-{   
-    "type": "vcs",
-    "url": "https://github.com/dotkernel/mezzio-hal"
-}
-```
+
+      {   
+          "type": "vcs",
+          "url": "https://github.com/dotkernel/mezzio-hal"
+      }
 
 - Remove "`mezzio/mezzio-hal`" package from composer.json
 - Delete composer.lock
-- Run ```
-      $ composer require dotkernel/dot-doctrine-metadata
-      ``` 
-- Register the package’s `ConfigProvider` in `/config/config.php` in the `//DK Packages` section 
-``Dot\DoctrineMetadata\ConfigProvider::class,``
+- Run `composer require dotkernel/dot-doctrine-metadata`
+- Register the package’s `ConfigProvider` in `/config/config.php` in the `//DK Packages` section
+  `Dot\DoctrineMetadata\ConfigProvider::class,`

SECURITY.md

@@ -0,0 +1,39 @@
+# Security Policy
+
+## Supported Versions
+
+
+| Version  | Supported          | PHP Version                                                                                                           |
+|----------|--------------------|-----------------------------------------------------------------------------------------------------------------------|
+| 3.x      | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-doctrine-metadata/3.2.2) |
+| <= 2.x   | :x:                |                                                                                                                       |
+
+## Reporting Potential Security Issues
+
+If you have encountered a potential security vulnerability in this project,
+please report it to us at <[email protected]>. We will work with you to
+verify the vulnerability and patch it.
+
+When reporting issues, please provide the following information:
+
+- Component(s) affected
+- A description indicating how to reproduce the issue
+- A summary of the security vulnerability and impact
+
+We request that you contact us via the email address above and give the
+project contributors a chance to resolve the vulnerability and issue a new
+release prior to any public exposure; this helps protect the project's
+users, and provides them with a chance to upgrade and/or update in order to
+protect their applications.
+
+
+## Policy
+
+If we verify a reported security vulnerability, our policy is:
+
+- We will patch the current release branch, as well as the immediate prior minor
+  release branch.
+
+- After patching the release branches, we will immediately issue new security
+  fix releases for each patched release branch.
+

docs/book/index.md

@@ -0,0 +1 @@
+../../README.md

docs/book/v3/configuration.md

@@ -0,0 +1,5 @@
+# Configuration
+
+After installation, register `dot-doctrine-metadata` in your project by adding the below line to your configuration aggregator (usually: `config/config.php`):
+
+     Dot\DoctrineMetadata\ConfigProvider::class,

docs/book/v3/installation.md

@@ -0,0 +1,5 @@
+# Installation
+
+Install `dotkernel/dot-doctrine-metadata` by executing the following Composer command:
+
+    composer require dotkernel/dot-doctrine-metadata

docs/book/v3/migrating-from-previous-integrations.md

@@ -0,0 +1,19 @@
+# Migrating from previous integrations
+
+To migrate from previous integrations please follow the below steps, in order:
+
+- Remove the previous fork from composer.json at the `repositories` key :
+
+      {   
+          "type": "vcs",
+          "url": "https://github.com/dotkernel/mezzio-hal"
+      }
+
+- Remove "`mezzio/mezzio-hal`" package from composer.json
+- Delete composer.lock
+- Run below command:
+
+      composer require dotkernel/dot-doctrine-metadata
+
+- Register the package’s `ConfigProvider` in `/config/config.php` in the `//DK Packages` section
+  `Dot\DoctrineMetadata\ConfigProvider::class,`

docs/book/v3/overview.md

@@ -0,0 +1,4 @@
+# Overview
+
+`dot-doctrine-metadata` Provides metadata and strategies for extracting and rendering Doctrine entities.
+This package is a wrapper for `mezzio/mezzio-hal` which addresses the doctrine entity proxy metadata issue when using `mezzio/mezzio-hal` to generate HAL responses.

mkdocs.yml

@@ -0,0 +1,19 @@
+docs_dir: docs/book
+site_dir: docs/html
+extra:
+  project: Packages
+  current_version: v3
+  versions:
+    - v3
+nav:
+  - Home: index.md
+  - v3:
+      - Overview: v3/overview.md
+      - Installation: v3/installation.md
+      - Configuration: v3/configuration.md
+      - "Migrating From Previous Integrations": v3/migrating-from-previous-integrations.md
+site_name: dot-doctrine-metadata
+site_description: "DotKernel's component to provide metadata and strategies for extracting and rendering Doctrine entities."
+repo_url: "https://github.com/dotkernel/dot-doctrine-metadata"
+plugins:
+  - search