Join the Documentation Team!

Added by Muntek Singh over 7 years ago

Howdy,

I was recently charged with leading the newly-created Documentation team and am actively looking for dedicated members to join me.

I am planning a complete overhaul of the redmine wiki, as well and a full refresh of the Redmine Documentation.

Contact me via this thread, or even better my catching me on IRC - my nickname is Khalsa, if you are interested in helping out!

Replies (11)

RE: Join the Documentation Team! - Added by Holger Just over 7 years ago

I just created the HowTo_Use_Hooks page. Feel free to edit in any way necessary. This is the first attempt to create a more extensive documentation on creating Plugins. The goal should be to have all the common techniques documented (or at least to provide links to good explanations). Equally (or even more) important would be to document all that small and not-so-small APIs lingering in the code.

That way, we could foster the creation of new plugins and keep up the idea of a more modular Redmine. I will try to provide some of that documentation in the next weeks.

And I'm definitely "yay" to a Wiki overhaul. We have some good information already but the visibility of all that is rather low unfortunately. I would love to help to improve that.

--Holger

RE: Join the Documentation Team! - Added by Eric Davis over 7 years ago

Holger Just wrote:

I just created the HowTo_Use_Hooks page. Feel free to edit in any way necessary. This is the first attempt to create a more extensive documentation on creating Plugins.

Great, thank you. It's important to understand how the hooks work because there are plenty of edge case bugs with them still.

I've also created a "script" that automates the hook creation, just give it the hook name you want to call and it will create the class/methods and update init.rb automatically. I've used it on my last few plugins and just need to refine it a bit more before I make it public. (It also scripts how to monkey patch Redmine.)

Eric Davis

RE: Join the Documentation Team! - Added by jon hertzig over 7 years ago

Hi There,

I've written about 100 pages of documentation on how to use Redmine, for a client who's given the go-ahead for me to share back with the community. It's done in Redmine wiki pages, using some formatting tricks to include a navigation/toc tree in a 'pane' at left on all pages. Not onsite today, but I'll upload a couple of screengrabs tomorrow so you can see what it looks like.

Cheers,

jh

RE: Join the Documentation Team! - Added by Muntek Singh over 7 years ago

Wow that sounds great! I can't wait to see (and get) what you've got. Newer versions of redmine include the ability to have an editable sidebar (the one on the right). Maybe we can massage your tricks into being there.

RE: Join the Documentation Team! - Added by jon hertzig over 7 years ago

Below are some of the screens (the help title page, section heading for reporting & tracking issues, a table showing roles & permissions, and a page of wiki formatting tips). I'm working on copying these pages to another instance of Redmine, so I can sanitize them and send to you (under my name, not my client's).

Cheers,
jh

Using Redmine (help "title" page)

!Using Redmine.png!

Reporting & tracking issues (section heading for user procedures on reporting & tracking issues)

!Reporting and tracking issues.png!

Roles and permission (developer page with table of permissions)

!Roles and permissions.png!

Formatting tips and tricks (developer page with tips & tricks for using Redmine markup)

!Formatting tips and tricks.png!

Using_Redmine.png - Intro Help page (189 KB)

Reporting_and_tracking_issues.png - Section heading page for user procedures to report & track issues (132 KB)

Roles_and_permissions.png - Roles & Permissions Table (234 KB)

Formatting_tips_and_tricks.png - Wiki formatting tips (487 KB)

RE: Join the Documentation Team! - Added by jon hertzig over 7 years ago

missing the underscores in the filenames there -- but I think it's best to leave them out anyway (too big to embed in a forum posting!)

RE: Join the Documentation Team! - Added by jon hertzig over 7 years ago

As part of scrubbing what I've done to remove anything proprietary to my client. before sending back to the project, I'm realising that:
  • most of the screengrabs need replacing — is the generic 'Redmine' project (that everyone has access to) the best example ?
  • a lot of the procedures have changed (between what I've documented and the existing instance of the public Redmine.org project) — not sure whether that's because of enhancements to Redmine from Redmine.org, or hacks from my client.

I can spend a couple of hours a week working on this myself, to update the pages to match the latest release, if you want to add me to the project.

Cheers,
jh

RE: Join the Documentation Team! - Added by Muntek Singh over 7 years ago

You can use redmine.org for sshots, or if not applicable (like you need to update something etc. use ux.redmight.com or demo.redmine.org. If you need admin I will make you admin at ux.

UX.redmight.com is running latest trunk.

If you want to privately share your stuff with me (under NDA or whatever you need) I'd be happy to help speed up the process.

Come by IRC and ping me (nick Khalsa) or you can skype me (sikhnerd) if you see that I'm on and we can chat :)

RE: Join the Documentation Team! - Added by jon hertzig over 7 years ago

Hi there... we've just upgraded, and I've gone through a process of copying our Redmine to a personal instance, so I could upgrade the help (in a wiki of a project called 'Documentation'). And I've got some time to start sanitizing it to contribute back to Redmine.org. A couple of issues:
  • I've relied heavily on being able to format the text. The flag for that is: changing self-filter_styles=true to self-filter_styles=false in /lib/redmine/wiki_formatting/textile/formatter.rb. Also, changing to border: 0px ... under div.wiki table in public/stylesheets/application.css
  • For screengrabs, demo.redmine.org gives me very random projects, and I would rather not have to recreate a set of representative projects and issues — and ux.redmine.com is cluttered with spam projects and issues. Is there anywhere I could get access to a real (representative but not proprietary) set of projects and issues to capture?
  • There's still the issue of how to extract the project (or just the wiki) from my instance, to insert in another. Here, I ended up just cutting and pasting every page between instances. Are there any plans for adding the facility to export and import projects?

Cheers,
jh

RE: Join the Documentation Team! - Added by Jeffrey Jones about 7 years ago

That left hand navigation pane is fantastic!

Definitely interested in learning how you did that.

RE: Join the Documentation Team! - Added by jon hertzig about 7 years ago

Cheers. Basically it's a table, using the {{include}} and {{child_pages}} macros.

I've lost touch — what's the status of using this for Redmine.org ?

(1-11/11)