[
https://issues.apache.org/jira/browse/THRIFT-4710?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17045919#comment-17045919
]
Mario Emmenlauer edited comment on THRIFT-4710 at 2/26/20 9:39 PM:
-------------------------------------------------------------------
I think the current build system (cmake and/or autotools) can generate docs for
at least a number of languages. And some language API docs that are currently
not generated may be easy to add.
A question would be from which webspace to serve them since they may not be
best served from readthedocs. I assume readthedocs enforces quite a strict
layout, and not many static API pages may accept this?
As an alternative, I personally haven't used github pages, but supposedly its
quite easy to generate pages from travis-ci (example for
[https://github.com/EmaroLab/docs/wiki/Automatic-deployment-Doxygen-documentation])
or similar.
In my personal opinion the API docs should be linked from the readthedocs
documentation but I do not think they need to reside on the same server, as
long as the server has good reliability and good integration into thrifts build
system.
was (Author: emmenlau):
I think the build system can build docs for at least a number of languages, and
some that are currently not generated may be easy to add. But since these docs
would probably be more tied to the source code, and since they may not be best
served from readthedocs, a question would be from which webspace to serve them.
I personally haven't used github pages, but supposedly its quite easy to
generate them from travis-ci (example for
[https://github.com/EmaroLab/docs/wiki/Automatic-deployment-Doxygen-documentation])
or similar. In my personal opinion the API docs should be linked from the
readthedocs documentation but I do not think they need to reside on the same
server, as long as the server has good reliability and good integration into
thrifts build system.
> 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.13.0
> Reporter: James E. King III
> Assignee: Duru Can Celasun
> 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
(v8.3.4#803005)
