New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Change doc layout #606
Conversation
👍 Looks much much better. |
This is one of the best project documentations that I have seen. Thanks a lot Ufuk for doing this! I would merge this as is. Few minor thoughts I had when skimming through the docs:
|
Is there a way a preview version uploaded somewhere, or a screenshot, or do I need to build the docs myself? |
Very difficult to visualize all the changes with screenshots but it takes a few seconds to build the website. From your Flink source directory:
Now open your browser at http://localhost:4000 |
I like the new docs layout :-) |
It looks much better. I'm +1 for merging it immediately like this. Once its merged, I would propose to make some minor changes:
|
+1 Love it |
* This will be replaced by the TOC | ||
{:toc} | ||
|
||
This documentation is intended to provide instructions on how to run Flink locally on a single machine. | ||
|
||
## Download | ||
|
||
Go to the [downloads page]({{site.baseurl}}/downloads.html) and get the ready to run package. If you want to interact with Hadoop (e.g. HDFS or HBase), make sure to pick the Flink package **matching your Hadoop version**. When in doubt or you plan to just work with the local file system pick the package for Hadoop 1.2.x. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link to the "downloads page" is broken. It will point to http://ci.apache.org/projects/flink/flink-docs-master/downloads.html which doesn't exist.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I got this feedback from a Disqus comment of a user. I think its very valuable to have these comment boxes below the pages.
Why did you remove the Disqus comments from the pages? |
Addressed:
Open:
Can someone check it out again and then merge. |
350cc07
to
41272cc
Compare
- Changed layout (simple as possible) - Fix broken version references in docs - Update README - Removed dead resources - Reorganized content [docs] Address PR comments [docs] Address @ktzoumas comments [docs] Fix download link [docs] Fix front page stack link to Tez
Good to merge |
- Changed layout (simple as possible) - Fix broken version references in docs - Update README - Removed dead resources - Reorganized content [docs] Address PR comments [docs] Address @ktzoumas comments [docs] Fix download link [docs] Fix front page stack link to Tez This closes apache#606.
- Changed layout (simple as possible) - Fix broken version references in docs - Update README - Removed dead resources - Reorganized content [docs] Address PR comments [docs] Address @ktzoumas comments [docs] Fix download link [docs] Fix front page stack link to Tez This closes apache#606.
- Changed layout (simple as possible) - Fix broken version references in docs - Update README - Removed dead resources - Reorganized content [docs] Address PR comments [docs] Address @ktzoumas comments [docs] Fix download link [docs] Fix front page stack link to Tez This closes apache#606.
This is not completely done yet, but should suffice to give a feeling of the new layout. I think this is a good improvement over our current state.
Missing & coming up:
Note that a couple of links are changing with this update, but this is OK since it is only affecting the SNAPSHOT version of our docs.