diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 23633df65..5e1523f7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,8 +12,8 @@ Guidelines: * Report your __browser type and version__, any __JavaScript errors in the console__ and any other details like __server operating system__, __php version__, __SQL Server type and version__ etc. * Check your logs, especially your __Web Server Log__ as well as __app/logs/partkeepr.log__ * Only attach the parts of the logs which are __relevant__ to the problem. -* Make sure the problem is __reproducable__. If it only happened one time, you have to find out on how to reproduce it. -* Explain, in simple words, __when__ the issue occured. For example: Don't write "I can't create a part". Rather write: "I clicked on Add Part, entered a Part Name, then I clicked the save button, then nothing happens. There were no JavaScript errors in the console, and no HTTP Request was sent." +* Make sure the problem is __reproducible__. If it only happened one time, you have to find out on how to reproduce it. +* Explain, in simple words, __when__ the issue occurred. For example: Don't write "I can't create a part". Rather write: "I clicked on Add Part, entered a Part Name, then I clicked the save button, then nothing happens. There were no JavaScript errors in the console, and no HTTP Request was sent." * Try to limit your bug report to only __essential__ steps on how to reproduce the issue. * In short, help the volunteers maintaining the project to spend as little effort as possible on the issue, so that we can have more time adding features and fixing bugs more easily. diff --git a/app/PartKeeprRequirements.php b/app/PartKeeprRequirements.php index d429258fb..87d8374df 100644 --- a/app/PartKeeprRequirements.php +++ b/app/PartKeeprRequirements.php @@ -24,7 +24,7 @@ function_exists('imagecreate'), $this->addRequirement( function_exists('imagettftext'), sprintf('GD library has no FreeType support'), - sprintf('Install the FreeType extension and make sure GD extention can use it') + sprintf('Install the FreeType extension and make sure GD extension can use it') ); $this->addRequirement( diff --git a/app/config/parameters.php.dist b/app/config/parameters.php.dist index 90cdc8820..90679c04d 100644 --- a/app/config/parameters.php.dist +++ b/app/config/parameters.php.dist @@ -96,7 +96,7 @@ $container->setParameter('fr3d_ldap.driver.username', null); // The password to use for LDAP queries $container->setParameter('fr3d_ldap.driver.password', null); -// true to require a DN for binding attemts, false otherwise +// true to require a DN for binding attempts, false otherwise $container->setParameter('fr3d_ldap.driver.bindRequiresDn', false); // The base DN to query for users diff --git a/docker/README.md b/docker/README.md index 409dbda95..a1d1c7a27 100644 --- a/docker/README.md +++ b/docker/README.md @@ -19,7 +19,7 @@ This image is not ready to run but serves as a basis for the other images relate The docker-compose file registers multiple container services. The main PartKeepr application is called `app`. The database is a basic configuration with `mariadb:10.1` for compatibility. Third, there is a service called `initdb`. Its purpose is to restore the database and `data` folder to a pristine state. This one should normally not be used unless one wants to reset the database. -**Note:** There needs to be a useful default inserted into the initdb. At the moment it only clears out the database to be valid but containing no parts at all. Exactly the situtation you have after a fresh installation. Some test data might be useful here. +**Note:** There needs to be a useful default inserted into the initdb. At the moment it only clears out the database to be valid but containing no parts at all. Exactly the situation you have after a fresh installation. Some test data might be useful here. ## The main development image @@ -54,13 +54,13 @@ This guide assumes, you have just freshly checked out the PartKeer repository fr - Call `docker-compose pull` to fetch all images from the docker hub. Alternatively you could [build the images manually](#building-the-images-manually). - Now you need to fire up the database and let it initialize. This is done by callng `docker-compose up -d db`. You can peek into the process by `docker-compose logs -f db`. Wait for a message that the server is ready for connections and listening on port 3306. Using ``, you can exit from the logs. - Build the `initdb` image by calling `docker-compose build initdb`. This will take a few moments as it builds a docker image. - By default the line `RESET_DATABASE: 'yes'` in the file `docker-compose.yml` is commented. This is to avoid accidentially removing your data. Uncomment the line. Then: + By default the line `RESET_DATABASE: 'yes'` in the file `docker-compose.yml` is commented. This is to avoid accidentally removing your data. Uncomment the line. Then: - Initialize the data by calling `docker-compose up initdb`. - Recomment the line in the `docker-compose.yml` file you just uncommented. - Now, you can fire up the main container by calling `docker-compose up -d app`. - The container will initialize some dependencies. This might take some time as well. Again using `docker-compose logs -f app` you can peek into the process and with `` you can return to the console. There might be some error messages regarding missing tables. -- The partkeepr instance is avaliable at http://127.0.0.1:8082/. +- The partkeepr instance is available at http://127.0.0.1:8082/. - Note: If you don't set `PARTKEEPR_FORCE_UPDATE` to `yes` in the `docker-compose` file on your first run you will get a white screen as you need to start the [setup](http://127.0.0.1:8082/setup/) once. Just accept the defaults but do not create a new set of users (keep the existing ones) and select HTTP Basic authentication. - You may or may or not want to set up a cron job as described. The check is disabled by default. - Alternatively, you can run the cron command manually with `php app/console partkeepr:cron:run` after logging in to the container with `docker exec -it partkeepr_dev_app_1 bash`. diff --git a/docker/development/app/user-entrypoint.sh b/docker/development/app/user-entrypoint.sh index 4e60451bd..f8029ed93 100755 --- a/docker/development/app/user-entrypoint.sh +++ b/docker/development/app/user-entrypoint.sh @@ -4,7 +4,7 @@ cd /var/www/pk # Check if parameters are present if [ ! -f app/config/parameters.php ]; then - echo 'No configuration was found yet. A defult configuration was generated.' >&2 + echo 'No configuration was found yet. A default configuration was generated.' >&2 echo 'Please visit the setup page if you encounter issues.' >&2 # Remove any db related config from the dist file diff --git a/src/PartKeepr/AuthBundle/Services/UserService.php b/src/PartKeepr/AuthBundle/Services/UserService.php index 34d7fc35b..988acb823 100644 --- a/src/PartKeepr/AuthBundle/Services/UserService.php +++ b/src/PartKeepr/AuthBundle/Services/UserService.php @@ -96,7 +96,7 @@ public function getProviderTypeByClass($providerClass) } /** - * Syncronizes the data of the given user with the FOSRestBundle. + * Synchronizes the data of the given user with the FOSRestBundle. * * * @param $user diff --git a/src/PartKeepr/CoreBundle/Services/SystemService.php b/src/PartKeepr/CoreBundle/Services/SystemService.php index dbb686d57..d634cfed6 100644 --- a/src/PartKeepr/CoreBundle/Services/SystemService.php +++ b/src/PartKeepr/CoreBundle/Services/SystemService.php @@ -113,7 +113,7 @@ public function getSystemInformation() /** * Returns the database schema status. * - * This method is usuall called once the user logs in, and alerts him if the schema is not up-to-date. + * This method is usually called once the user logs in, and alerts him if the schema is not up-to-date. * * Returns either status incomplete if the schema is not up-to-date, or complete if everything is OK. */ diff --git a/src/PartKeepr/FrontendBundle/Resources/public/js/Components/ModelTreeMaker/ModelTreeMaker.js b/src/PartKeepr/FrontendBundle/Resources/public/js/Components/ModelTreeMaker/ModelTreeMaker.js index 6dd85a91a..b0466eadc 100644 --- a/src/PartKeepr/FrontendBundle/Resources/public/js/Components/ModelTreeMaker/ModelTreeMaker.js +++ b/src/PartKeepr/FrontendBundle/Resources/public/js/Components/ModelTreeMaker/ModelTreeMaker.js @@ -38,7 +38,7 @@ Ext.define("PartKeepr.ModelTreeMaker.ModelTreeMaker", { * @param {Ext.data.NodeInterface} node The current node * @param {Ext.data.Model} model The model * @param {String} prefix The prefix. Omit if first called - * @param {Function} callback The calback, optional + * @param {Function} callback The callback, optional */ make: function (node, model, prefix, callback) { diff --git a/src/PartKeepr/FrontendBundle/Resources/public/js/Components/StorageLocation/StorageLocationMultiAddWindow.js b/src/PartKeepr/FrontendBundle/Resources/public/js/Components/StorageLocation/StorageLocationMultiAddWindow.js index eeb560405..e377868da 100644 --- a/src/PartKeepr/FrontendBundle/Resources/public/js/Components/StorageLocation/StorageLocationMultiAddWindow.js +++ b/src/PartKeepr/FrontendBundle/Resources/public/js/Components/StorageLocation/StorageLocationMultiAddWindow.js @@ -82,7 +82,7 @@ Ext.define("PartKeepr.StorageLocationMultiCreateWindow", { this.addButton.enable(); if (response.data.length > 0) { - Ext.Msg.alert(i18n("Errors occured"), implode("
", response.data)); + Ext.Msg.alert(i18n("Errors occurred"), implode("
", response.data)); } else { this.close(); } diff --git a/src/PartKeepr/FrontendBundle/Resources/public/js/Components/Widgets/EntityQueryPanel.js b/src/PartKeepr/FrontendBundle/Resources/public/js/Components/Widgets/EntityQueryPanel.js index 20d6017bd..3303ca090 100644 --- a/src/PartKeepr/FrontendBundle/Resources/public/js/Components/Widgets/EntityQueryPanel.js +++ b/src/PartKeepr/FrontendBundle/Resources/public/js/Components/Widgets/EntityQueryPanel.js @@ -254,8 +254,8 @@ Ext.define("PartKeepr.Widgets.EntityQueryPanel", { }, /** - * Syncronizes the internal columns storage with the grid. The reason it is done that way is because we can't - * operate on the return value of getColumns() directly, as these are instanciated objects which get removed + * Synchronizes the internal columns storage with the grid. The reason it is done that way is because we can't + * operate on the return value of getColumns() directly, as these are instantiated objects which get removed * during a reconfigure operation. */ syncColumns: function () diff --git a/src/PartKeepr/FrontendBundle/Resources/public/js/Data/CallActions.js b/src/PartKeepr/FrontendBundle/Resources/public/js/Data/CallActions.js index ebdea1a68..f57dc2c5f 100644 --- a/src/PartKeepr/FrontendBundle/Resources/public/js/Data/CallActions.js +++ b/src/PartKeepr/FrontendBundle/Resources/public/js/Data/CallActions.js @@ -94,7 +94,7 @@ Ext.define("PartKeepr.data.CallActions", { /** * Sets data to all associations * - * @param {Object} data The associations to set. Silently ignores non-existant associations. + * @param {Object} data The associations to set. Silently ignores non-existent associations. */ setAssociationData: function (data) { diff --git a/src/PartKeepr/FrontendBundle/Resources/public/js/Data/HydraModel.js b/src/PartKeepr/FrontendBundle/Resources/public/js/Data/HydraModel.js index 8a4d838a3..176a7e53f 100644 --- a/src/PartKeepr/FrontendBundle/Resources/public/js/Data/HydraModel.js +++ b/src/PartKeepr/FrontendBundle/Resources/public/js/Data/HydraModel.js @@ -287,7 +287,7 @@ Ext.define("PartKeepr.data.HydraModel", { /** * Sets data to all associations * - * @param {Object} data The associations to set. Silently ignores non-existant associations. + * @param {Object} data The associations to set. Silently ignores non-existent associations. */ setAssociationData: function (data) { diff --git a/src/PartKeepr/FrontendBundle/Resources/public/js/Ext.ux/NumericField.js b/src/PartKeepr/FrontendBundle/Resources/public/js/Ext.ux/NumericField.js index 0b1028340..db23f6476 100644 --- a/src/PartKeepr/FrontendBundle/Resources/public/js/Ext.ux/NumericField.js +++ b/src/PartKeepr/FrontendBundle/Resources/public/js/Ext.ux/NumericField.js @@ -26,7 +26,7 @@ Ext.define('Ext.ux.NumericField', { }, /** - * Converts a Float value into a currency formated value ready to display . + * Converts a Float value into a currency formatted value ready to display . * * @param {Object} value * @return {Object} The converted value. @@ -45,7 +45,7 @@ Ext.define('Ext.ux.NumericField', { * * See {@link #rawToValue} for the opposite conversion. * - * This implementation converts the raw value to a value formated as currency. + * This implementation converts the raw value to a value formatted as currency. * * @param {Object} value The mixed-type value to convert to the raw representation. * @return {Object} The converted raw value. diff --git a/src/PartKeepr/FrontendBundle/Resources/public/js/Util/Crypto/bcrypt.js b/src/PartKeepr/FrontendBundle/Resources/public/js/Util/Crypto/bcrypt.js index 3546c6a33..4f48d4f07 100644 --- a/src/PartKeepr/FrontendBundle/Resources/public/js/Util/Crypto/bcrypt.js +++ b/src/PartKeepr/FrontendBundle/Resources/public/js/Util/Crypto/bcrypt.js @@ -420,10 +420,10 @@ bCrypt.prototype.crypt_raw = function(password, salt, log_rounds, cdata, callbac var one_percent; if (log_rounds < 4) { - throw "Minium of 4 rounds required, changing to default"; + throw "Minimum of 4 rounds required, changing to default"; } if (log_rounds > 30) { - throw "Maximum of 30 rounds exceded"; + throw "Maximum of 30 rounds exceeded"; } if (salt.length != this.BCRYPT_SALT_LEN) @@ -556,7 +556,7 @@ bCrypt.prototype.hashpw = function(password, salt, callback, progress) { bCrypt.prototype.gensalt = function(rounds) { var iteration_count = rounds; if (iteration_count < 4 || iteration_count > 30) { - throw "Rounds exceded maximum (30)!" + throw "Rounds exceeded maximum (30)!" } var output = []; output.push("$2a$"); diff --git a/src/PartKeepr/FrontendBundle/Resources/public/js/Util/Crypto/isaac.js b/src/PartKeepr/FrontendBundle/Resources/public/js/Util/Crypto/isaac.js index 6257d917b..2739b9587 100644 --- a/src/PartKeepr/FrontendBundle/Resources/public/js/Util/Crypto/isaac.js +++ b/src/PartKeepr/FrontendBundle/Resources/public/js/Util/Crypto/isaac.js @@ -26,12 +26,12 @@ * (or CSPRNG for short) designed by Robert J. Jenkins Jr. in 1996 and * based on RC4. It is designed for speed and security. * - * ISAAC's informations & analysis: + * ISAAC's information & analysis: * http://burtleburtle.net/bob/rand/isaac.html * ISAAC's implementation details: * http://burtleburtle.net/bob/rand/isaacafa.html * - * ISAAC succesfully passed TestU01 + * ISAAC successfully passed TestU01 * * ---------------------------------------------------------------------- * diff --git a/src/PartKeepr/SetupBundle/Services/UnitSetupService.php b/src/PartKeepr/SetupBundle/Services/UnitSetupService.php index 4b69854b9..401e4921b 100644 --- a/src/PartKeepr/SetupBundle/Services/UnitSetupService.php +++ b/src/PartKeepr/SetupBundle/Services/UnitSetupService.php @@ -38,7 +38,7 @@ public function __construct(EntityManager $entityManager, KernelInterface $kerne /** * Imports units. * - * @throws \Exception If an error occured + * @throws \Exception If an error occurred * * @return array An array with the keys "skipped" and "imported" which contain the number of units skipped and imported */ diff --git a/src/PartKeepr/TipOfTheDayBundle/Command/SyncTipsCommand.php b/src/PartKeepr/TipOfTheDayBundle/Command/SyncTipsCommand.php index e01a9cb35..7082681fd 100644 --- a/src/PartKeepr/TipOfTheDayBundle/Command/SyncTipsCommand.php +++ b/src/PartKeepr/TipOfTheDayBundle/Command/SyncTipsCommand.php @@ -12,7 +12,7 @@ protected function configure() { $this ->setName('partkeepr:cron:synctips') - ->setDescription('Syncronizes the tips from the PartKeepr website'); + ->setDescription('Synchronizes the tips from the PartKeepr website'); } protected function execute(InputInterface $input, OutputInterface $output) diff --git a/src/PartKeepr/TipOfTheDayBundle/Services/TipOfTheDayService.php b/src/PartKeepr/TipOfTheDayBundle/Services/TipOfTheDayService.php index b242f19fb..4d55b7163 100644 --- a/src/PartKeepr/TipOfTheDayBundle/Services/TipOfTheDayService.php +++ b/src/PartKeepr/TipOfTheDayBundle/Services/TipOfTheDayService.php @@ -39,7 +39,7 @@ public function __construct(ContainerInterface $container, EntityManager $entity } /** - * Syncronizes the tip database against the master wiki. + * Synchronizes the tip database against the master wiki. * * @throws \Exception */ @@ -58,7 +58,7 @@ public function syncTips() * Updates the tip database. Expects an array of page names. * * This method clears all page names and re-creates them. This saves - * alot of engineering, because we don't need to match contents + * a lot of engineering, because we don't need to match contents * within the database against contents in an array. * * @param array $aPageNames The page names as array. Page names are stored as string. diff --git a/web/setup/js/Cards/ExistingConfigParserCard.js b/web/setup/js/Cards/ExistingConfigParserCard.js index fa0c62ed0..7b82f9636 100644 --- a/web/setup/js/Cards/ExistingConfigParserCard.js +++ b/web/setup/js/Cards/ExistingConfigParserCard.js @@ -1,5 +1,5 @@ /** - * This card runs the prequisites test to make sure basic things like PHP and Doctrine are installed and configured. + * This card runs the prerequisites test to make sure basic things like PHP and Doctrine are installed and configured. */ Ext.define('PartKeeprSetup.ExistingConfigParserCard', { extend: 'PartKeeprSetup.AbstractTestCard', diff --git a/web/setup/js/Cards/PrerequisitesTestCard.js b/web/setup/js/Cards/PrerequisitesTestCard.js index d22855dd9..65f57d6fb 100644 --- a/web/setup/js/Cards/PrerequisitesTestCard.js +++ b/web/setup/js/Cards/PrerequisitesTestCard.js @@ -1,5 +1,5 @@ /** - * This card runs the prequisites test to make sure basic things like PHP and Doctrine are installed and configured. + * This card runs the prerequisites test to make sure basic things like PHP and Doctrine are installed and configured. */ Ext.define('PartKeeprSetup.PrerequisitesTestCard', { extend: 'PartKeeprSetup.AbstractTestCard', diff --git a/web/setup/js/TestResultPanel.js b/web/setup/js/TestResultPanel.js index 5f278434c..71fff6896 100644 --- a/web/setup/js/TestResultPanel.js +++ b/web/setup/js/TestResultPanel.js @@ -120,7 +120,7 @@ Ext.define('PartKeeprSetup.TestResultPanel', { }, /** * Appends the specific test to the output panel, - * and fires the error event if an error occured. + * and fires the error event if an error occurred. * * @param test PartKeeprSetup.AbstractTest */