[
https://issues.apache.org/jira/browse/THRIFT-4710?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16972218#comment-16972218
]
Duru Can Celasun commented on THRIFT-4710:
------------------------------------------
I have finished an initial port of the existing website to Read The Docs using
Sphinx. You can see it here:
https://thrift-fork.readthedocs.io/en/docs/index.html
Source code: https://github.com/apache/thrift/compare/master...dcelasun:docs
Build instructions:
- Python 3.7 and virtualenv required
- cd /docs && virtualenv venv && source venv/bin/activate && make clean html &&
deactivate
This will generate the HTML version. The website has a PDF version as well.
Changelog & notes:
- Simplified tutorial, removed copy/pasted language specific code, linked to
Github instead.
- Moved the old package managers table into the download page.
- "How To Contribute" now includes everything from bug reports, PRs and adding
new languages.
- "Coding Standards" has been simplified greatly.
- Merged several pages, particularly around contributing to make them flow
better.
- Fix lots of grammar / spelling errors.
- Removed various outdated bits, particularly around old build errors.
Next steps:
- I will start integrating Thrift: The Missing Guide and will reach out to the
author. He has already given us permission, but that was 7 years ago so there
is no harm in checking with him again.
- Similarly I'll contact the RPC specification's author and seek his permission.
Any feedback & thoughts are welcome.
> 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)
