Skip to content

GSoC 2019 Proposal: Create syslog ng configuration snippets for VIM (krook1024)

Jump to bottom
Molnár Antal Albert edited this page Apr 24, 2019 · 3 revisions

Introduction

  • Vim is a widely used text editor among system administrators, programmers and basically people who work in the IT field. It is easy and very efficient to use once learnt. Vim is favored because it can run through a terminal session, so it comes handy when configuring a server or an other computer.

  • People who utilize syslog-ng are likely to be familiar with Vim itself. Therefore this project could come in handy when it comes for them to configure syslog-ng to their needs.

  • The project holds a lot of interest for me because I love Vim and I am interested in creating plugins to it. This project would be great to start with, I believe.

Deliverables

  • syslog-ng-vim would be a Vim extension that people could utilize to configure syslog-ng harder, better, faster, stronger.

Desirable skills

syslog-ng

  • As a simple exercise I've set up syslog-ng locally on three of my machines and set up a Raspberry Pi to collect all of the logs. This helped me get and idea of how useful syslog-ng is in a big enterprise environment.

Script languages

  • As I use a GNU/Linux distribution as my daily driver, I can say I am familiar with Bash as a scripting language. I've written rather smaller Bash scripts to extend the functionality of my Linux desktop.

  • I've also experimented with Python in the past (data mining mostly).

Vim

  • I've been a Vim user for about a year now and I use Vim as my editor of choice. I do everything related to my daily tasks in Vim, including notetaking through programming down to file management.

  • Even though I've never written Vim plugins before, I would like to learn the basics of it before GSoC starts and train myself throughout the project.

Needed improvements

I need to improve my skills on the following;

  • BISON
    • BISON rules, databases
  • Vim custom code snippets

Timeline

I plan on working 40 hours a week.

Days Before Rodeo (current day-May 6)

Community Bonding Period (May 6–27)

  • Familiarize myself with how configuring syslog-ng works and seek opportunities on what can be automated or made faster through Vim.

Weeks 1–4 (May 27–June 23)

  • Begin writing the Vim plugin.

Weeks 5–7 (June 24–July 14)

  • Set up CI for the plugin (automated tests and deploying).

Weeks 8-9 (July 15–28)

  • Make the Vim plugin better.

Weeks 10-11 (July 29–August 11)

  • Finalize the plugin, fix errors.

Week 12 (August 12–19)

  • The Vim plugin is done.

Contact

Clone this wiki locally