Tag: writing

Reviewdog is a tool to use with GitHub actions for applying review tools in your CI. I use it with Vale, and it's really good. One thing that has tripped me up multiple times is that by default, it only applies the checks to the changes in the pull request, not to the whole project. So when you add something like Vale, which is a prose linter, it only checks ... the workflow file you just added! I always forget that it works this way, and how to change it, so I'm pasting some examples for future reference.

Pandoc is one of my favourite tools in the world. If you haven't come across it before, it converts between more or less any two document formats. I use it a lot with MarkDown and ReStructuredText so that I can produce content efficiently and then share it in a way that looks nice, but also to get word documents into cleaner formats. However the PDF output has always looked a little bit ... dated? (this is rich from an rst2pdf maintainer I know!) and I was recently delighted to find some tricks that resulted in a better PDF. I'm sharing them here, so I can find them again in the future; you are welcome to use them too, of course!

For most of my career I've been a software developer, but now I'm mostly a communicator. As a manager, I give the right level of detail to many different audiences, and I deliver that in words they can understand. As a Developer Advocate, I explain complex technical concepts in useful, memorable, and occasionally entertaining ways. However the best software developers are lazy and I'm still always looking for ways to get things done with less effort on my part! For writing, the best process I know feels like unnecessary overhead, but it's always worth it in the end so today I'm sharing my secrets: create an outline before you start.

This is the 1000th post on https://beta.lornajane.net. People ask "how do you even do that?" and the short answer is "start in 2006", but the long answer isn't all that long.

I've been thinking lately about my own interactions online, especially around content. There are three main ways that I work with content: creating, curating and consuming. Each has their own place but I'll start by outlining each one.

Creating content is all about putting your own creations out for others to share. I've had this blog longer than I care to discuss and certainly since before microblogging was really a thing. It's much lower investment to throw out a quick tweet about something and in lots of cases it's a more appropriate medium

While I worked on this, we were using the wiki feature in GitLab ... which pretty much hit the nail on the head. Further investigation showed that the wiki feature in GitLab (and indeed in GitHub) is a ruby gem called Gollum.

I have a couple of books (so far!) published on Leanpub, and I often get asked by aspiring authors how it works. Everyone's tools will be different, but this is what works for me

I'm very pleased to announce the immediate availability of my new book Git Workbook, costing $20 from LeanPub. This is a book that you "do" rather than "read"; it's a series of chapters (30 ish so far) each covering one specific git skill.

Each chapter includes an explanation of the skill in question, followed by a hands-on exercise so that you can work through the skill yourself, and ends with a tickbox so you can keep track of how far through you are. It has quizzes, diagrams, mildly amusing stories, and as many other examples as I could think of that could help anyone to take in this technical topic and understand how to apply the techniques covered.

I'm writing more and more things that are not code these days, and my content-managing toolchains are becoming more developed all the time. I've written in REstructured Text, Asciidoc, and LaTeX, and today I'm working on an article which eventually wants to be HTML but I'm creating in Markdown because …

This is the 800th published post on lornajane.net. It's my personal blog and I started it in early 2006, when I moved to a new city with no job. I think I got the blogging bug just because I had nobody else to talk to at the time! Over the years the blog has recorded recipes, craft projects, the story of buying and refurbishing the house (a decision that a previous employer described as "brave") - and of course the vast swathes of technical snippets that are the regular content you see here.

You might have noticed that things have been a bit quiet around here lately ... that's because I'm writing a book and doing a lot of editing at the moment. I love doing both of these as part of my work, but it turns out that when you're already writing/editing …

Do you have a New Year's Resolution? Is it to blog (or blog more often)? If so, keep reading!

I'm coming up to my 5th anniversary of blogging and looking at my stats, I've written around 150 posts per year for most of that time, although in 2010 I "only" wrote 102 posts, possibly because one or two other things happened in my life. So many people tell me they want to blog, or they have a blog but can't find the time to write, that I thought I'd try to give some pointers for those resolving to blog this New Year.

Recently I was approached by a friend of mine looking to start his own technical blog. I've been blogging here for some years, and he wrote to ask my advice. I replied to him, but thought that the ideas could be useful to others in the same position, so here's that email, published here for anyone else who wants to see it:

A couple of weeks ago I gave a lightning talk at the PHPNW user group entitled "Geeks Can Write" or "Can Geeks Write?" - basically shooting down the worst of the excuses for not writing that I've heard and asking everyone to give it a shot! If you are interested, then …

I'm happy to announce that my new post 9 Magic Methods for PHP is live on Think Vitamin this morning. I've written a series of posts about OOP for the site, with a few more to come, and these "underscore-underscore" methods make for some very neat tricks with PHP, which …

I'm very pleased to say that today I have a a post about web services for PHP developers published on techPortal! OK so I edit techPortal so this is the written equivalent of introducing myself as a speaker but I enjoyed writing the post and I hope it'll be a …

I've been working on a series of articles for Think Vitamin, the Carsonified blog, about OOP in PHP5. In fact I'm wildly excited about this, partly because I love to write and partly because its such a cool site to write for! The first two installments are now live:

• Getting …

I'm very proud to be able to say "I'm a PHP Advent author" - I've been invited to take part in this year's event and my article One Step at a Time is now live!

My post this year is aimed as a reminder to us all that we can all …

Recently I've been spending a lot of time away from home, and busy with clients within office hours, which means I'm not available via my usual real-time communication mechanisms. This has given me the opportunity to enjoy email as a means of staying in touch with people that I would …

A few weeks ago I got a call from my employers, Ibuildings, asking me how I felt about changing my role a bit and taking on some of the functions of our PCE (PHP Centre of Expertise). This area of the company does some super-cool stuff and so I said …

I'm pleased to announce that a my tutorial on using PHP Code Sniffer is now available on techportal. I had the opportunity to work with PHPCS in a recent project and thought it was a great tool, and looked more closely into how it works and can be configured. I …

Today techportal published a new article of mine on their site - New Memcached Extension for PHP. Its a sequel to the article I wrote for them earlier in the year entitled Getting Started with Memcache. At the same time I wrote that first article, Andrei Zmievski released a new extension …

There is a new resource for PHP developers available from today - techPortal from Ibuildings. First, I must add the disclaimer - Ibuildings are my employers, so I've known about this project for a while. I helped set up the site and the first tech article on there is mine. With those …

I'm very excited to be able to say that I was published in php|architect, in December's issue. I had the /etc column, where I wrote a bit about phpwomen.org and what we're up to these days. As I've wanted to write for them for ages, I was very …