Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prestashop/doctoolsbundle
Helper tools for documentation
https://github.com/prestashop/doctoolsbundle
documentation prestashop
Last synced: about 2 months ago
JSON representation
Helper tools for documentation
- Host: GitHub
- URL: https://github.com/prestashop/doctoolsbundle
- Owner: PrestaShop
- License: mit
- Created: 2021-05-10T13:17:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T16:02:00.000Z (over 1 year ago)
- Last Synced: 2024-10-08T10:58:42.174Z (3 months ago)
- Topics: documentation, prestashop
- Language: PHP
- Homepage:
- Size: 86.9 KB
- Stars: 1
- Watchers: 19
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# DocToolsBundle
Helper tools for documentation
## Installation
As usual, there are a few steps required to install this bundle:
1.a **Add this bundle to your project using composer**:
```bash
$ composer require prestashop/doc-tools-bundle
```
1.b **Add this bundle to your project as a composer dependency (from your forked repository)**:
```javascript
// composer.json
{
// ...
require-dev: {
// ...
"prestashop/doc-tools-bundle": "dev-my-branch"
},
// ...
"repositories": [
// ...
{
"type": "vcs",
"url": "https://github.com/myfork/DocToolsBundle",
"canonical": false
},
// ...
],
}
```
```bash
$ composer require prestashop/doc-tools-bundle
```
2. **Add this bundle to your application kernel**:
```php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new PrestaShop\DocToolsBundle\DocToolsBundle(),
);
return $bundles;
}
```
3. **Configure the bundle via app/config**
```yml
# app/config/config.yml
doc_tools:
docs_src_path: /root/path/to/docs/project/src
cqrs_folder: content/1.7/development/architecture/domain/references
```
4. **How to use**
This bundle includes a few commands that you can use to generate documentations. The PrestaShop dev documentation is
versioned in this repository https://github.com/PrestaShop/docs, so you will have to clone it as well in order to export
the generated documentation.
## Command list
```bash
prestashop
prestashop:doc-tools:list-commands-and-queries Lists available CQRS commands and queries
prestashop:doc-tools:print-commands-and-queries Prints available CQRS commands and queries to a file prepared for documentation
```
### prestashop:doc-tools:print-commands-and-queries
When you generate CQRS commands documentation details you should export them into the `content/1.7/development/architecture/domain/references` folder of the Docs project.
```bash
php ./bin/console prestashop:doc-tools:print-commands-and-queries --dir=/path/to/doc_project/src
```
Or if you correctly set the `docs_src_path` config you can simply run:
```bash
php ./bin/console prestashop:doc-tools:print-commands-and-queries
```
5. **How to test**
This bundle includes automatic tests which are run automatically by GitHub actions. You can run them locally by using:
Unit tests:
```bash
composer run unit-tests
```
Integration tests:
```bash
composer run integration-tests
```
Test all:
```bash
composer run test-all
```