PHPNews

Why Is My Website So Slow?!

If there's almost one universal constant in the modern world, it's that business need websites. The sites come in many shapes and sizes. There's the old-style " brochure " website, that just says where you can find them, their opening hours, and the basics of their service offering. They're nothing special, but …

Continue reading »

Written by Matthew Setter - - Aggregated on Friday September 27, 2019


Don't Write Code When You Don't Have To

If you haven't spent much time writing any technical documentation, or if you've never been a technical writer, you might think that technical writers wouldn't write a lot of code. However, at least in my experience, nothing could be further from the truth. There’s example code (in Curl , Java , PHP , Python , …

Continue reading »

Written by Matthew Setter - - Aggregated on Friday August 23, 2019


How to Create Redirects in Antora

Speaking from experience, creating redirects in Antora is quite trivial, as it only involves two steps: Use page attributes to create redirects in source files. Use the --redirect-facility option when building your documentation. 1. Use Page Attributes to Create Redirects In Source Files While not too …

Continue reading »

Written by Matthew Setter - - Aggregated on Thursday May 30, 2019


Find What's Using a Port With Two Commands

Recently, when I was using Node Serve to locally deploy the ownCloud documentation , so that I could review some changes I'd made, it couldn't bind to its standard port (5000). I knew that I'd run Node Serve the day before, but thought that the process had been killed. Yet the docs were still rendering, and Node …

Continue reading »

Written by Matthew Setter - - Aggregated on Monday March 4, 2019


Make Sure You’re Technical Documentation’s Always Professional With Proselint

So far, in this series, we've covered three excellent tools ( MarkdownLint , Broken Link Checker , and write-good ). Each of them help improve technical documentation quality whether by giving us suggestions for improving what — or how — we've written, or whether the file doesn't lint correctly for the chosen format …

Continue reading »

Written by Matthew Setter - - Aggregated on Wednesday February 20, 2019


Validate Your Markdown files with MarkdownLint

Before we dive in, I need to set the scene. When writing technical documentation, as with writing code, you need to use a range of tools to maintain a high level of quality. In this series, I'm going to introduce you to 4 tools that help you do just that. Each of them is usable from the command-line, whether manually …

Continue reading »

Written by Matthew Setter - - Aggregated on Friday December 21, 2018


Automate Repetitive Tasks With Make

If you're under about 35 years of age, you can be forgiven for not having heard of Make . It first appeared in April of 1976 ( a great year and month btw ); created by Stuart Feldman. If you're familiar with Ant , Rake , MSBuild , Phing , Capistrano , Maven , or tools of this nature, then you'll know, roughly, …

Continue reading »

Written by Matthew Setter - - Aggregated on Thursday October 18, 2018


Are You Too Wedded To Your Text Editor?

This is especially important if another text editor does all that I need, but also: Provides a better UX Is easier to use Is easier to install and configure Requires less effort Has a larger, more active community (so it's easier to get help and support) This might seem an odd thing to consider — …

Continue reading »

Written by Matthew Setter - - Aggregated on Thursday September 27, 2018


Google Chrome 69 Now Flags HTTP Websites

At first blush, it might seem that the changes in version 69 are only cosmetic. For example, in the screenshot above, you can see that Chrome’s Material Theme has been updated. For example, the tabs and the omnibus (address & search bar) have a softer, more rounded look. I don't know if you're a fan, but I …

Continue reading »

Written by Matthew Setter - - Aggregated on Saturday September 8, 2018