SRL Archive - Suggestions

Would it be useful to assign/assemble a documentation team? It would consist out of anyone from a junior member to SRL developer (although I guess the latter are usually quite busy). I'm sure we could eventually find a nice rank/cup for the ones doing a good job maintaining the documentation.

Things that come to mind: (Most stuff can be learned, tasks should just be executed…)

• Understanding how the documentation system/markup works; being able to explain this to others who want to write documentation / help out.
• Think about the current structure of the documentation, ways we can improve it. (Think about, moving parts around or entirely new chapters, or thinks we can remove)
• Write documentation. Note that I think although this would be useful, this is not a particular requirement, unless of course no one is writing documentation.
• Know your way about git, a little. So you can send pull requests to the Simba (or SRL-5) repository. (Patches are fine too)

So if you're somewhat enthusiastic about making something pretty and generally helping out starters as well as experienced programmers/scripters, this may be something for you. It really won't require a lot of experience and programming skills, just a bit of dedication and then some more…


For now I'm not going to ask who'd like to be a maintainer just yet (although you could come forward already I suppose), but I was wondering what other tasks you could think of a maintainer should do?

I'm not junior.
I'll help though if you want/need.

-Boom

From: Dynamite
I'm not junior.
I'll help though if you want/need.

-Boom

Why aren't you?

From: Nava2
Why aren't you?

Yeah, I think the rule is 6 months 100+ posts, but maybe the system has some problems.

From: Nava2
Why aren't you?

I iz awesome :)
Is it cause I was inactive? :cartman:
I don't wanna be junior thanks.

-Boom

Why not open documenting for all SRL Members+, and require registration if you are a Junior Member?

Since maybe those who are not dedicated to the development of the documentation can maybe (when reading) fix up minor spelling/grammatical errors and contribute one(or more)-off.

Because, I would like to assist in the documentation where I can, but I cannot guarantee complete commitment to it.

I could give it a shot :)

From: Daniel
Why not open documenting for all SRL Members+, and require registration if you are a Junior Member?

Since maybe those who are not dedicated to the development of the documentation can maybe (when reading) fix up minor spelling/grammatical errors and contribute one(or more)-off.

Because, I would like to assist in the documentation where I can, but I cannot guarantee complete commitment to it.

You can easily do that by forking the git repo. and sending pull requests.

Wizzup, I think you'll have to make sure who ever is doing it can explain the functions properly and use good examples that are clear and easy to understand. What exactly did you have in mind for the team, though? I mean, it's not like you need to give "commit rights" or anything as people can just fork and send pull requests. I suppose a title (maybe?) and a cup would be okay incentive. I think you'll need people who are willing to write a nice guide on exactly how to do it properly plus outline how you want it organized out so you're getting the most information across to the user.

I don't know if that made any sense. :p

From: Coh3n
You can easily do that by forking the git repo. and sending pull requests.

Wizzup, I think you'll have to make sure who ever is doing it can explain the functions properly and use good examples that are clear and easy to understand. What exactly did you have in mind for the team, though? I mean, it's not like you need to give "commit rights" or anything as people can just fork and send pull requests. I suppose a title (maybe?) and a cup would be okay incentive. I think you'll need people who are willing to write a nice guide on exactly how to do it properly plus outline how you want it organized out so you're getting the most information across to the user.

I don't know if that made any sense. :p

That made sense. On an unrelated note, I've done some work on the documentation today.

Daniel, Smarter Child, Dynamite, Coh3n, I don't think you need to spent a lot of time on this when you're a maintainer, I just think we need some people who also understand how it works, how we'd like to see if, to be able to carry that idea over to other people who want to contribute.

I'll be home in a week, so perhaps we can meet on IRC and I can try to carry over my ideas to you guys and we can help some people write documentation? :)

From: Wizzup?
That made sense. On an unrelated note, I've done some work on the documentation today.

Daniel, Smarter Child, Dynamite, Coh3n, I don't think you need to spent a lot of time on this when you're a maintainer, I just think we need some people who also understand how it works, how we'd like to see if, to be able to carry that idea over to other people who want to contribute.

I'll be home in a week, so perhaps we can meet on IRC and I can try to carry over my ideas to you guys and we can help some people write documentation? :)

Understanding isn't difficult. I think there's a link somewhere. Ah, here. :) May not even need to look at that as people can just look at the already completed parts of the Simba doc. Could also look at MSI's as it uses the same format.

From: Coh3n
Understanding isn't difficult. I think there's a link somewhere. Ah, here. :) May not even need to look at that as people can just look at the already completed parts of the Simba doc. Could also look at MSI's as it uses the same format.

Yes, but not everyone tends to take initiative just like that, most won't just start looking at already existing documentation, that's why I wanted a team of some sort to stimulate people to actually do something.