GitHub user alpinegizmo opened a pull request:
https://github.com/apache/flink/pull/2940
[FLINK-5258] [docs] reorganize the docs to improve navigation and reduce
duplication
Goals:
* improve navigation and discoverability: important topics shouldn't be
hard to find
* reduce duplication: ideally every piece of information would have one
natural place to be
* arrange the content in a natural, linear ordering for those who want to
read (or skim through) everything
This pull request moves content around, and in some cases merges sections
with major overlap. When I noticed them I fixed small wording problems and
typos, and I did somewhat more significant editing in the concepts section.
The results can be reviewed at https://alpinegizmo.github.io/flink-docs/
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/alpinegizmo/flink reorg-docs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/2940.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #2940
----
commit df5d32655639539f2730cd16afa893623f28acb7
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T14:44:21Z
updated doc building gems and script to allow for incremental regeneration
commit d4728222b0be95076dfaf78f8ec4d3324977d3a5
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:09:41Z
Align and style the top-level title elements in the sidebar nav.
commit f842c28f99912c5279613aeb4a8147ab0f15f7cc
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:26:06Z
Navigation reorganization.
commit e93d152cd1c7e4c82fa743379a73b84498fa904e
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:31:58Z
Split off the explanation of how to link with additional modules into its
own page.
commit 56a938668d2b0106ad98072b9e116fbad15630d2
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:34:42Z
Split the concepts page into two, did some rewriting of the content.
commit 1161633bc2827f0d1b8743eeb76f921b2b7e1f8f
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:36:52Z
Split off part of the API concepts page into its own page.
commit e6b0d531005f59081e1c8b3d449542affe39bd7d
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:37:50Z
Split up the general architecture page and removed redundant content.
commit ca3a3d63a2371a83178c32924637e0cf8bf74c78
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:39:44Z
Put the material about running flink on windows into its own page.
commit 9133989c83739a548670a1fc442d479a3cf06c3d
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:44:16Z
Eliminated the local setup page. Moved small bits of it into the quickstart
page.
commit e3a78ddae3782b2abc2eff4b11fa7b41e44c51bf
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:45:33Z
Moved some introductory material about savepoints into the runtime page in
the concepts section.
commit 484e0ec5d102a8d390e841441667507fd5df2afb
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:47:44Z
clarified that this page is about dataset operators
commit ea4c29c993883a70e6cdb7db414f0da2ce6c94d4
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:48:41Z
Moved info about setting JAVA_HOME into the configuration page.
commit e659ae0aa67d317c6fcf8ff7820031e858ec0163
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T15:49:16Z
Added temporary content about GOALS and TODOs.
commit a07f65f7f23e8bc0e153d0e802e85d6d94962bf5
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-25T21:41:47Z
introduced more structure into the sidenav, dividing it into three sections
commit ec4303d3cb46c2e1eb662a75cf43ddd26346d0fb
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-11-28T09:52:37Z
little tweak of the ordering
commit 44f190dfe42cbb075480b66b8e48cd09e3835138
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-02T14:20:18Z
Further navigational and structural changes. Split up the Failure &
Recovery page; split up the Managing Execution page; moved several pages
underneath Streaming; moved Custom Serializers and Fault Tolerance Guarantees
to their own pages; moved Best Practices under App Dev.
commit 8d33ad38c60329fb4bf9b93035faab0a95c5ea7a
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-02T15:20:32Z
fixed typos
commit 91f86e594424b0ecfea015e5cc8037da59fe92f3
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-04T13:34:32Z
Put IntelliJ before Eclipse.
commit d21a319141789c4b31fe697e283d8d63d7d1bc8a
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-04T13:47:54Z
Move linking_with_flink into its own file.
commit 8a71c47a8331425b306cb808e11eef73a1fdbe08
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-04T14:03:53Z
Fixed broken links.
commit 14a7c5fb3313ced8d9eae92d9ef411a97d1741c7
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-04T14:09:01Z
Added more examples.
commit e4542fd54624a0a93eceb3ca44a27d371203b324
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-04T14:14:06Z
Updated the quickstart. Included the code (scala first, since it's so much
prettier), and moved/merged the cluster setup info into existing cluster_setup
page.
commit 2e7c6b72c7669007db177fbd96cefcaab22852df
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-04T14:18:49Z
Navigation updates.
commit 4632c4e78e2c2afbae54e6aff533b760f4750a5c
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-04T14:23:52Z
Small wording changes.
commit 9c35c2523f48f5cf5de4b0df50665eb27be00cb5
Author: David Anderson <da...@alpinegizmo.com>
Date: 2016-12-05T09:59:31Z
[FLINK-5258] [docs] reorganize the docs to improve navigation and reduce
duplication
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
