Briddle
Briddle

Hi,

When browsing the documentation I noticed that it currently lacks a section that explains the basics of working with October from the perspective of end-users. I think that adding such a section at the beginning (before diving into the more technical stuff) would improve the overall documentation and help smooth the transition to the more complex parts of the documentation by clarifying some basic design principles to webmasters and designers.

What do you think?

Last updated

Briddle
Briddle

Also...

I wonder if requiring pull-requests on Git to contribute to documentation does not, in fact, create an unneeded obstacle for people to contribute.

In comparison, wikis require no special tooling for contributors and could even allow them to submit contributions from their phone (much lower threshold).

Forking, changing and creating a pull-request on a computer may not seem like a big deal when you do it once. But if you want people to contribute regularly it is.

Doing or not doing something that only takes me an extra minute every day results in me having either gained or lost almost an entire day being productive or enjoying the sun (someting I also often tell my wife :)).

Last updated

Eoler
Eoler

Briddle said: Forking, changing and creating a pull-request on a computer may not seem like a big deal when you do it once. But if you want people to contribute regularly it is.

If you have an Github account and go here: https://github.com/octobercms/docs every .MD file listed has "Fork this project and edit the file" button. Seems frictionless enough for me...

Briddle
Briddle

Eoler said:

If you have an Github account

Why would you need a GitHub account to contribute to clarifying code though? Do not get me wrong. I am a developer an I know developers love GitHub. But documenting software is different from contributing to code.

Documentation improves if people from different backgrounds can contribute (this would include end-users, and designers). As much as I hate the term, GitHub is not very "inclusive" for them.

... and that brings me back to the lack of documentation from the perspective of end-users and designers :)

Last updated

LukeTowers
LukeTowers

Feel free to write up what you think would be helpful and send it in. We could eventually use the WIP RainLab.Docs plugin to handle this sort of thing, and then we could accept change requests through the plugin itself.

Briddle
Briddle

Thanks Luke,

I am already well under way :)

1-7 of 7