Production Readiness Checklist
| Build Status | |
|---|---|
| master branch QA Release | |
| master branch Prod Release |
Overview
This is a simple, survey-based tool, to help teams assess where they currently are on their Production Readiness and to help them identify next steps for further improvement.
Getting Help
Reporting Bugs
Please open a GitHub Issue and include as much information as possible. If possible, provide sample code that illustrates the problem you're seeing. If you're seeing a bug only on a specific repository, please provide a link to it if possible.
We ask that you not open a GitHub Issue for help, only for bug reports.
Reporting Security Issues
Please have a look at SECURITY.md.
How Can I Contribute?
We welcome new contributors! Please review GitHub Issue
as a good place to jump in and get started.
Fork us and submit a pull request! If you are updating questions.json or advice.json, please check that it passes a JSON validator (such as JSONLint).
Please be sure to check the contribution guidelines to
understand our workflow
If you would like to adjust colours/branding for your own purpose, please do this in a separate branch. For example, you may maintain an xyzco-colours branch, and changes to the main code could be merged into xyzco-colours from master.
Installation
This is a PHP application that should run on any server that supports PHP 5.5 or higher with Mod_Rewrite enabled.
Technical Overview
- Survey questions are configured in questions.json
- When a user first accesses the survey, all the questions are loaded into session storage
- As the user completes the survey, their responses are saved in session storage
- Loading questions, processing responses, and generating summary results is all managed by the Survey class defined in survey.php
- Rendering of the survey is performed by collectResponses.php
- Rendering of the survey results is performed by viewResults.php
- Layout uses customised Bootstrap 4.1.3
- Rendering charts uses Chart.js 2.7.2
- Icons from Font Awesome Free 5.3.1
License
This source code is released under the MIT license. Bootstrap and Chart.js are also released under the MIT license. Font Awesome Free and Comfortaa is provided under the SIL OFL 1.1 License
Credits
- DevOpsGroup experts who have contributed to formulation of the questions and Atos for the creation of the application
- Bootstrap
- Chart.js
- Font Awesome Free
- Comfortaa Font
- Markus Spiske for background image, published on Unsplash
- Vojtech Bruzek for og-image.jpg, published on Unsplash