Skip to content
This repository was archived by the owner on Jan 31, 2020. It is now read-only.

Commit d4d50fe

Browse files
authored
Merge pull request #100 from froschdesign/hotfix/homepage
Updates homepage of documentation
2 parents 3396ce7 + c6b4672 commit d4d50fe

File tree

5 files changed

+47
-60
lines changed

5 files changed

+47
-60
lines changed

.zf-mkdoc-theme-landing

Whitespace-only changes.

docs/book/index.html

-13
This file was deleted.

docs/book/introduction.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Introduction
2+
3+
zenddiagnostics provides diagnostic tests for real-world PHP applications.
4+
5+
It currently ships with the following diagnostic checks:
6+
7+
- [ApcFragmentation](diagnostics.md#apcfragmentation) - check if APC memory fragmentation is below given threshold,
8+
- [ApcMemory](diagnostics.md#apcmemory) - check available APC memory,
9+
- [Callback](diagnostics.md#callback) - call a user-defined diagnostic function,
10+
- [ClassExists](diagnostics.md#classexists) - make sure class exists in current environment,
11+
- [CouchDBCheck](diagnostics.md#couchdbcheck) - check if connection is possible,
12+
- [CpuPerformance](diagnostics.md#cpuperformance) - check server CPU performance is above baseline,
13+
- [DirReadable](diagnostics.md#dirreadable) - make sure given path is readable,
14+
- [DirWritable](diagnostics.md#dirwritable) - make sure given path is writable,
15+
- [DiskFree](diagnostics.md#diskfree) - check there's enough free space on given path,
16+
- [DiskUsage](diagnostics.md#diskusage) - check if the disk usage is below warning/critical percent thresholds,
17+
- [DoctrineMigration](diagnostics.md#doctrinemigration) - make sure all migrations are applied.
18+
- [ExtensionLoaded](diagnostics.md#extensionloaded) - make sure extension is loaded,
19+
- [GuzzleHttpService](diagnostics.md#guzzlehttpservice) - check if given http host is responding using Guzzle,
20+
- [HttpService](diagnostics.md#httpservice) - check if given http host is responding,
21+
- [Memcache](diagnostics.md#memcache) - check if memcache extension is loaded and given server is reachable,
22+
- [Mongo](diagnostics.md#mongodb) - check if connection to MongoDb is possible,
23+
- [OpCacheMemory](diagnostics.md#opcachememory) - check if the OpCache memory usage is below warning/critical thresholds,
24+
- [PDOCheck](diagnostics.md#pdocheck) - check if connection is possible,
25+
- [PhpVersion](diagnostics.md#phpversion) - make sure that PHP version matches constraint,
26+
- [PhpFlag](diagnostics.md#phpflag) - make sure that given PHP flag (feature) is turned on or off.
27+
- [ProcessRunning](diagnostics.md#processrunning) - check if a process with given name or ID is currently running,
28+
- [RabbitMQ](diagnostics.md#rabbitmq) - Validate that a RabbitMQ service is running,
29+
- [Redis](diagnostics.md#redis) - Validate that a Redis service is running,
30+
- [SecurityAdvisory](diagnostics.md#securityadvisory) - check installed composer dependencies against SensioLabs SA database,
31+
- [StreamWrapperExists](diagnostics.md#streamwrapperexists) - make sure given stream wrapper is available.
32+
33+
It also provides the following file validation checks:
34+
35+
- [IniFile](file-validation.md#inifile) - check if given INI file is available and valid,
36+
- [JsonFile](file-validation.md#jsonfile) - check if given JSON file is available and valid,
37+
- [XmlFile](file-validation.md#xmlfile) - check if given XML file is available and valid,
38+
- [YamlFile](file-validation.md#yamlfile) - check if given YAML file is available and valid

docs/book/usage.md

+1-39
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,4 @@
1-
# Introduction and Usage
2-
3-
zendframework/zenddiagnostics provides diagnostic tests for real-world PHP
4-
applications.
5-
6-
It currently ships with the following diagnostic checks:
7-
8-
- [ApcFragmentation](diagnostics.md#apcfragmentation) - check if APC memory fragmentation is below given threshold,
9-
- [ApcMemory](diagnostics.md#apcmemory) - check available APC memory,
10-
- [Callback](diagnostics.md#callback) - call a user-defined diagnostic function,
11-
- [ClassExists](diagnostics.md#classexists) - make sure class exists in current environment,
12-
- [CouchDBCheck](diagnostics.md#couchdbcheck) - check if connection is possible,
13-
- [CpuPerformance](diagnostics.md#cpuperformance) - check server CPU performance is above baseline,
14-
- [DirReadable](diagnostics.md#dirreadable) - make sure given path is readable,
15-
- [DirWritable](diagnostics.md#dirwritable) - make sure given path is writable,
16-
- [DiskFree](diagnostics.md#diskfree) - check there's enough free space on given path,
17-
- [DiskUsage](diagnostics.md#diskusage) - check if the disk usage is below warning/critical percent thresholds,
18-
- [DoctrineMigration](diagnostics.md#doctrinemigration) - make sure all migrations are applied.
19-
- [ExtensionLoaded](diagnostics.md#extensionloaded) - make sure extension is loaded,
20-
- [GuzzleHttpService](diagnostics.md#guzzlehttpservice) - check if given http host is responding using Guzzle,
21-
- [HttpService](diagnostics.md#httpservice) - check if given http host is responding,
22-
- [Memcache](diagnostics.md#memcache) - check if memcache extension is loaded and given server is reachable,
23-
- [Mongo](diagnostics.md#mongodb) - check if connection to MongoDb is possible,
24-
- [OpCacheMemory](diagnostics.md#opcachememory) - check if the OpCache memory usage is below warning/critical thresholds,
25-
- [PDOCheck](diagnostics.md#pdocheck) - check if connection is possible,
26-
- [PhpVersion](diagnostics.md#phpversion) - make sure that PHP version matches constraint,
27-
- [PhpFlag](diagnostics.md#phpflag) - make sure that given PHP flag (feature) is turned on or off.
28-
- [ProcessRunning](diagnostics.md#processrunning) - check if a process with given name or ID is currently running,
29-
- [RabbitMQ](diagnostics.md#rabbitmq) - Validate that a RabbitMQ service is running,
30-
- [Redis](diagnostics.md#redis) - Validate that a Redis service is running,
31-
- [SecurityAdvisory](diagnostics.md#securityadvisory) - check installed composer dependencies against SensioLabs SA database,
32-
- [StreamWrapperExists](diagnostics.md#streamwrapperexists) - make sure given stream wrapper is available.
33-
34-
It also provides the following file validation checks:
35-
36-
- [IniFile](file-validation.md#inifile) - check if given INI file is available and valid,
37-
- [JsonFile](file-validation.md#jsonfile) - check if given JSON file is available and valid,
38-
- [XmlFile](file-validation.md#xmlfile) - check if given XML file is available and valid,
39-
- [YamlFile](file-validation.md#yamlfile) - check if given YAML file is available and valid
1+
# Basic Usage
402

413
## Performing diagnostics with Zend Framework 2
424

mkdocs.yml

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
docs_dir: docs/book
22
site_dir: docs/html
3-
pages:
4-
- index.md
5-
- usage.md
3+
nav:
4+
- Home: index.md
5+
- Introduction: introduction.md
6+
- 'Basic Usage': usage.md
67
- Checks:
78
- "Diagnostic Checks": diagnostics.md
89
- "File Validation Checks": file-validation.md
910
- Reference:
1011
- Architecture: architecture.md
11-
- "Custom Checks": custom-checks.md
12-
- "Custom Reporters": custom-reporters.md
13-
site_name: ZendDiagnostics
14-
site_description: 'A set of components for performing diagnostic tests in PHP applications.'
12+
- "Writing Custom Checks": custom-checks.md
13+
- "Writing Custom Reporters": custom-reporters.md
14+
site_name: zenddiagnostics
15+
site_description: 'Universal set of diagnostic tests for PHP applications.'
1516
repo_url: 'https://github.com/zendframework/zend-diagnostics'
16-
copyright: 'Copyright (c) 2013-2018 <a href="https://www.zend.com/">Zend Technologies USA Inc.</a>'

0 commit comments

Comments
 (0)