Posted by
zentol on
URL: http://deprecated-apache-flink-mailing-list-archive.368.s1.nabble.com/GitHub-incubator-flink-pull-request-FLINK-963-Initial-import-of-docume-tp649.html
GitHub user uce opened a pull request:
https://github.com/apache/incubator-flink/pull/34 [FLINK-963] Initial import of documentation from website into source code
This is [FLINK-963](
https://issues.apache.org/jira/browse/FLINK-962).
This is the initial import of the current documentation from
http://www.stratosphere.eu/docs/0.5. It is not finished yet, but I chose to do the PR asap in order to get some help from others to speed this up. I tried to fix everything on my own, but it is simply too much for me right now. I managed to fix up most parts, but quick starts and programming guides are still under construction (see blow).
To make it clear: the layout stuff is not finished and just very simple. But the great thing about this change is that layout and content are now completely independent of each other. So we can continue with the conent, while I or someone else continue on the layout.
All documentation pages are organized in a flat hierarchy in the new `docs` directory (this makes links between doc pages way simpler, e.g. `{{ site.baseurl }}/docs/{{ site.version}}/programming_guides/java_api.html` vs. ``java_api_guide.html`). In contrast to the old documentation, we can just rely on Markdown ([GitHub flavored](
http://github.github.com/github-flavored-markdown)) for the pages. The headings in the document are used to generate a per-page outline.
The provided `docs/build_docs.sh` script generates the docs to `docs/target` and can be run in preview mode `docs/build_docs.sh -p` to start a local webserver on port 4000.
What needs to be done:
1. Trim pages to plain Markdown
2. Fix links to GitHub
3. Fix references to old ``site`` variables
4. Fix images
5. Improve the layout
Thanks to some upcoming automation scripts by @rmetzger, we will be able use the same Markdown files on the upcoming website (with different layout).
I would like to merge this, if everyone agrees with the general setup and then divide the remaining work.
You can merge this pull request into a Git repository by running:
$ git pull
https://github.com/uce/incubator-flink docs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-flink/pull/34.patchTo close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #34
----
commit dfb53d21c644d8196e296e6f85192abaaf6a437c
Author: uce <
[hidden email]>
Date: 2014-06-21T13:14:05Z
[FLINK-963] Initial import of documentation from website into source code
----
---
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
[hidden email] or file a JIRA ticket
with INFRA.
---