You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@thrift.apache.org by "James E. King III (JIRA)" <ji...@apache.org> on 2019/02/01 04:57:00 UTC

[jira] [Commented] (THRIFT-4710) Move all ASF CMS website content to GitHub

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

James E. King III commented on THRIFT-4710:
-------------------------------------------

There are advantages to keeping the documentation in the same repository.  For example links to code snippets can be relative.  You can disable builds in CI easily when committing documentation changes.

See this page for an example of "readthedocs" integration with a GitHub repo that contains docs and code:

[https://solidity.readthedocs.io/en/v0.5.3/]

I don't want to have to maintain two repositories.

> 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)