Contributing to OpenLP: Looking for Technical Writers

edited April 1 in General Support

Hello OpenLP community!

With just a handful of us actively working on OpenLP, and that on constrained time, we don't always have the time to look at updating our manual and our wiki. So I thought I'd reach out to the community to see if there are any "technical writers" out there (or people willing to learn a little technical stuff) to help us update our manual.

Requirements:

  • Proficiency in English
  • Experience with version control (we use git, but Subversion, Bazaar or Mercurial experience is fine)
  • Experience with lightweight markup (we use reStructuredText, but Markdown or Asciidoc is fine)
  • Experience with the command line (Terminal, Console, PowerShell, etc)

None of these requirements are mandatory, as long as you're willing to get a little technical and learn a thing or two. Also, while we primarily use Linux, you can do this on any platform, including Windows.

If you'd like to help out, please take a look at the openlp/documentation repository on GitLab. For help with git, reStructuredText, etc, feel free to pop into our IRC channel and ask us in there. Be aware that not everyone is active all the time, and you might need to wait a while (hours, even) for someone to respond.

Happy hacking!

Comments

  • Do you have a list of which documents/sections need to be written from scratch or updated — the scope of work required?

    Assuming, of course, that this is for OpenLP 3, not much sense in writing for the soon to be superseded version.

    Screenshots seem to be from the Linux version? Is that a requirement?

  • @FromOZ

    Do you have a list of which documents/sections need to be written from scratch or updated — the scope of work required?

    Not really (I would need to go through it myself and find all the instances that need work, and I haven't got the time right now). Mostly just updating things to match 3.0. I don't think we really need anything new.

    Screenshots seem to be from the Linux version? Is that a requirement?

    I like to try to keep things consistent across the docs, including screenshots. The current ones are from Linux because that's what I use. If you need a screenshot I can take one for you.

  • I can help. Long time it pro, BA, PM, not the developer, but understand what they do and communicate with end users. Wow instructions, short manuals, etc. Compared to most people, I'm a techie, can develop in low code tools like FileMaker. I use GIT to manage my rollouts, just for myself, not in a shared environment.

    I've never done anything in the open source, shared sorry of environment, so I'd need some guidance to get started. If you want to point me toward what needs to be done and how to communicate with you, I'll do what I can.

Sign In or Register to comment.