thrift-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "James E. King III (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (THRIFT-4710) Move all ASF CMS website content to GitHub
Date Fri, 10 May 2019 16:49:00 GMT

    [ https://issues.apache.org/jira/browse/THRIFT-4710?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16837435#comment-16837435
] 

James E. King III edited comment on THRIFT-4710 at 5/10/19 4:48 PM:
--------------------------------------------------------------------

I recently gained some experience working with readthedocs.io and I would recommend using
it.  The documentation is checked into the same repository as the project under {{/docs}}.
 Whenever you push to master (we also may be able to have PR builds, not sure yet) it would
rebuild the documentation.  The latest semver tag is considered the "stable" unless you set
it explicitly in a configuration file.  In short, this works quite well and would allow us
to move.  It's quite a bit of work to do however, considering all the build and installation
instructions need to be updated.

I used sphinx, that's probably what I would use here.


was (Author: jking3):
I recently gained some experience working with readthedocs.io and I would recommend using
it.  The documentation is checked into the same repository as the project under {{/docs}}.
 Whenever you push to master (we also may be able to have PR builds, not sure yet) it would
rebuild the documentation.  The latest semver tag is considered the "stable" unless you set
it explicitly in a configuration file.  In short, this works quite well and would allow us
to move.  It's quite a bit of work to do however, considering all the build and installation
instructions need to be updated.

> Move all ASF CMS website content to GitHub
> ------------------------------------------
>
>                 Key: THRIFT-4710
>                 URL: https://issues.apache.org/jira/browse/THRIFT-4710
>             Project: Thrift
>          Issue Type: Documentation
>          Components: Documentation, Website
>    Affects Versions: 0.12.0
>            Reporter: James E. King III
>            Priority: Major
>
> Recent changes in Apache infrastructure has made it impossible to use the existing ASF
CMS system to manage the Apache Thrift web site.  We need to extract and move the content
somewhere else.  For reference, see:
> https://issues.apache.org/jira/browse/INFRA-17519
> This is a bunch of work nobody was expecting to have to do.
> My recommendation is to put the documentation into the "docs/" (or leave it in "doc/",
perhaps, it if works) and use https://readthedocs.org/ to create the documentation web site.
 Documentation updates can be pushed into the repository with {{`[ci skip]`}} or maybe we
teach GitHub and/or our Appveyor and Travis to do nothing on pull requests that only contain
updates to markdown and/or rst files.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message