Contributing to OpenLP: Looking for Technical Writers
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.
@eprostko We'd love your help!
If you look at the Git repository with the documentation in it, there's a README file with some instructions:
There is also a fairly detailed page on the Wiki:
In terms of what needs to be done, the whole manual probably needs a bit of a refresh to match OpenLP 3.0 (currently 2.9.5). There are some issues in the documentation issue tracker already, and you can probably add more.
Hi, I posted this on IRC but I was having trouble with the IRC client, so I’m reposting here. Sorry if this already was answered.
Hi, I was wondering if there is still a need for technical writers on this project. I am an English major, and former science teacher, with training in web development. I currently teach commercial truck law and mechanical systems at a trade school. I’m looking to get into technical writing and I need to build a portfolio. I love Open LP and I have been using it for around 5 years; it has been a real blessing to my little church and I’d like to give back.
someone from dev team, please check https://gitlab.com/openlp/documentation/-/merge_requests
Thanks. How can I update my gitlab forked repo from the upstream? I cant see such button in gitlab.
Have a look at https://docs.gitlab.com/ee/user/project/repository/mirror/
@jednou from your local repository, do the following:
If you don't have an "upstream" remote, add it:
Then, switch to master, and pull the latest commits:
Then, push the latest commits to your origin repository: