[RFC] Documentation System and Requirements

These requests for comments/change have lead to an implemented feature that has been successfully merged into the 3.1/Ascraeus branch. Everything listed in this forum will be available in phpBB 3.1.
User avatar
nickvergessen
Former Team Member
Posts: 733
Joined: Sun Oct 07, 2007 11:54 am
Location: Stuttgart, Germany
Contact:

Re: [RFC] Documentation System and Requirements

Post by nickvergessen » Sat Feb 07, 2015 1:31 pm

MichaelC wrote:... it also means that arduous and unnecessary core development processes must be followed for documentation development (Commit messages, unable to use the github flow, topic branch naming requirements etc.)
We could also lessen that for doc-only PRs
MichaelC wrote:I would support having two repositories and instead having a similar system to Symfony where it is required that a PR exists against the docs repo...
Which conflicts with your first requirement?
MichaelC wrote:You shouldn't need to have to checkout a git repo locally or have to create JIRA issues or know about git branching or rebasing etc.
Member of the Development-TeamNo Support via PM

Nicofuma
3.2 Release Manager
3.2 Release Manager
Posts: 297
Joined: Sun Apr 13, 2014 1:40 am
Location: Paris

Re: [RFC] Documentation System and Requirements

Post by Nicofuma » Sat Feb 07, 2015 1:45 pm

He means to contribute to the documentation, not to contribute to the core.

There is two kind of contributors here:
- one who work on a feature and should/could also provide the documentation for this feature
- one who work only on the documentation (improvements, fix, translation....)

And we should assume that the second kind of contributor doesn't know anything about git or Github, he wants to be able to clic on the edit button on Github.
Member of the phpBB Development-Team
No Support via PM

User avatar
MichaelC
Website Team Leader
Website Team Leader
Posts: 889
Joined: Thu Jan 28, 2010 6:29 pm

Re: [RFC] Documentation System and Requirements

Post by MichaelC » Sat Feb 07, 2015 2:33 pm

nickvergessen wrote:
MichaelC wrote:I would support having two repositories and instead having a similar system to Symfony where it is required that a PR exists against the docs repo...
Which conflicts with your first requirement?
MichaelC wrote:You shouldn't need to have to checkout a git repo locally or have to create JIRA issues or know about git branching or rebasing etc.
Nicofuma wrote:And we should assume that the second kind of contributor doesn't know anything about git or Github, he wants to be able to clic on the edit button on Github.
Indeed, the 'Github Flow' can be used by documentation contributors.
Formerly known as Unknown Bliss
psoTFX wrote: I went with Olympus because as I said to the teams ... "It's been one hell of a hill to climb"
No unsolicited PMs please except for quotes.

User avatar
naderman
Product Manager
Product Manager
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

Re: [RFC] Documentation System and Requirements

Post by naderman » Thu May 28, 2015 11:58 am

Based on this discussion we are in the process of setting up sphinx documentation. It is being created in the 3.1.x and master branches of the existing documentation repository at https://github.com/phpbb/documentation/ ... evelopment. The development directory contains the new developer documentation while the documentation directory contains the existing end user documentation on http://www.phpbb.com.

Post Reply