[
https://issues.apache.org/jira/browse/AURORA-15?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13859280#comment-13859280
]
Jake Farrell commented on AURORA-15:
------------------------------------
There is work being done on a gitpubsub within infra which would accommodate
making the site out of git and possibly allow for a set path to be published.
This work is still a ways off, for now I would suggest that we keep as much as
possible on the website to help with any seo and provide one location for
people to go looking for any information about setup, contribution, etc.
We could also write a custom plugin for middleman to pull the git repo down and
add it to the site when generating the website and put it in a set path like
/docs in the publish folder
> Automate process of updating and rendering documentation on Aurora website
> --------------------------------------------------------------------------
>
> Key: AURORA-15
> URL: https://issues.apache.org/jira/browse/AURORA-15
> Project: Aurora
> Issue Type: Wish
> Components: Documentation
> Reporter: Dave Lester
>
> As documentation is added to the project at Apache, we've adopted the
> practice of storing files to the /docs/ folder within the main Aurora
> repository. However, the minimal docs currently on the website do not
> dynamically pull from this source.
> Ideally, we would automate the process of copying and rendering documentation
> on the website, so whenever a change is made to the /docs/ folder of the
> Aurora repository those changes also appear on the website.
> For Mesos, we currently have a separate build script that you run prior to
> making any changes to the website. This means we'll run that script every
> time the docs are updated, and then someone will commit any changes to
> subversion. Ideally, a documentation workflow for Aurora would include a
> post-commit hook for the main Aurora repo and a script that would run at that
> time.
> I think this latter solution should work, as long as there is general
> agreement that any changes to the website documentation should be derived
> from the /docs/ source and not made manually -- otherwise we could run into
> some merge conflicts.
> Thoughts?
--
This message was sent by Atlassian JIRA
(v6.1.5#6160)
