The Publishing Project

Tagging and preparing a Github release

I don’t normally do releases of my code. Whatever is on Github is what works and what I use to work with the code. There are times when a release of code at specific development milestones is necessary (for example when you’d like people to beta test or when it’s ready for a 1.0 release). This is a description of my basic process to commit code and create a tag. I can then go in to Github and create a release based on the tags. Committing code The first step is to commit the code. I use the command line

Installing plugins and themes using github-updater

As far as I know, unless you put your themes and plugins in the directories, you can’t update themes and plugins through the admin interface, you’ll have to delete them and upload them again. git-updater provides a mechanism to update plugins and themes from a Git repository (Github, GitLab or BitBucket) without having to publish them. Download the plugin and upload it to your WordPress installation or install it directly from your WordPress admin plugin interface. Before we can install our code using the plugin we need to add a header in the style.css header or in the plugin’s header

Linting WordPress PHP code

One thing I’ve always tried to do is lint my PHP code as I go when working with WordPress so it won’t bite me later if I try to submit the theme or plugin to the WordPress repositories. The best, and as far as I know only, way to efficiently lint PHP code is with PHP Code Sniffer and the WordPress rules to accompany it. The process includes installing PHP Code sniffer, optionally creating a configuration file, and running the code, either from the command line or from an existing build file. Installation Methods There are many ways to install

Configuring Vuepress default theme

In the last post we discussed the basic setup of a barebones Vuepress site. This post will cover some basic details of the theme: the navigation menu and the sidebar. To create the configuration you need to create the directory where Vuepress stores its data. From the root of the site create a .vuepress directory. mkdir -p /docs/.vuepress/ Inside the .vuepress directory, create a config.js file. The rest of the work will be done in this file. The first part of the module export declaration defines some basic metadata for the site. The head array will contain a list of

Docs as code: The technical side

Docs as code is an interesting way to create documentation for software and technical projects. The idea is that we use the same tools to create our documentation that engineers or technical authors use to create their projects. According to Write the Docs: Documentation as Code (Docs as Code) refers to a philosophy that you should be writing documentation with the same tools as code: Issue Trackers Version Control (Git) Plain Text Markup (Markdown, reStructuredText, Asciidoc) Code Reviews Automated Tests This means the technical writing process follows the same workflows as the rest of the development team and enables a