[
https://issues.apache.org/jira/browse/MESOS-744?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13796466#comment-13796466
]
Dave Lester commented on MESOS-744:
-----------------------------------
Currently, the Mesos website uses Jekyll to render a set of template files.
Right now, we link externally to github (such as
https://github.com/apache/mesos/blob/master/docs/Configuration.md) because they
render markdown files for us. There's no way to easily import and render those
same files if they're just a folder within the main mesos repository. If the
docs were their own repository that's separate from both the Mesos core and the
website, we could easily automate the process of rendering them within
mesos.apache.org by including and rendering them on the mesos website. Make
sense?
Your idea about automating the creation of RB requests is interesting, perhaps
[~chrismattmann] or [~jfarrell] know of other projects who are handling GH pull
requests that way. For the purposes of this issue, though, I'm focused on docs
-- if we'd like to investage using github pull requests for the core I think
that should be a separate issue.
> Possibly move /docs/ folder out of Mesos core, into separate repo
> -----------------------------------------------------------------
>
> Key: MESOS-744
> URL: https://issues.apache.org/jira/browse/MESOS-744
> Project: Mesos
> Issue Type: Documentation
> Reporter: Dave Lester
> Assignee: Dave Lester
> Priority: Minor
>
> I'd like to propose moving the /docs/ folder out of the Mesos core, and into
> a separate repo on github. This is a good idea for a few reasons, including:
> 1) We could easily share the repo between Mesos git repository (/docs/ would
> included as a submodule), as well imported into the Mesos website. Currently,
> docs files are not used in the Mesos website, so we have to send users to
> github to view rendered markdown. Breaking it into a separate repo would
> would make it simple for us to render the docs at mesos.apache.org
> 2) It would be significantly easier for community members to contribute. A
> simple pull request could make minor changes. In fact, a number of these
> changes have already been made to the documentation
> (https://github.com/apache/mesos/pulls), but we have no current way to
> process them. Right now our process requires the same level of complexity and
> creating unique Apache accounts if they want to make simple updates to the
> documentation.
> 3) It could provide an opportunity for community ownership of the docs, which
> at this point have tended to be an afterthought of core developers.
> The only main disadvantage that I see in this approach would be maintaining
> an additional repository and possible coordination in releases, however I see
> this as relatively minor. The specifics of how this affects tagging could be
> discussed further, I don't feel strongly about it.
--
This message was sent by Atlassian JIRA
(v6.1#6144)
