Skip to content
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

Closed
wants to merge 1 commit into from
Closed

[docs] Change doc layout #606

wants to merge 1 commit into from

Conversation

uce
Copy link
Contributor

@uce uce commented Apr 16, 2015

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.

  • Changed layout (simple as possible)
  • Fix broken version references in docs
  • Update README
  • Removed dead resources
  • Reorganized content

Missing & coming up:

  • Minor layout fixes (in comparison to the old version, this layout is way way simpler... it's essentially Bootstrap + minor customization)
  • Content reorganization (too long documents, broken links etc.)

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.

@mxm
Copy link
Contributor

mxm commented Apr 16, 2015

👍 Looks much much better.

@ktzoumas
Copy link
Contributor

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:

  • Perhaps we can find a better font for the code samples (not sure if applicable in this PR, perhaps this is a separate PR with a bunch of content refactoring)
  • Was it not possible to have the navigation on the left or was it a conscious choice to have it on the right?
  • Move Flink on Tez under Setup, since programming a job is the same, deployment is different?
  • "Programming guides" seems a bit too narrow for what it contains (e.g., Local/Cluster execution). Perhaps rename to "Usage"?
  • Not sure if the whole internals section is better fit for the docs or the wiki, but this is a ML discussion

@StephanEwen
Copy link
Contributor

Is there a way a preview version uploaded somewhere, or a screenshot, or do I need to build the docs myself?

@mxm
Copy link
Contributor

mxm commented Apr 17, 2015

Very difficult to visualize all the changes with screenshots but it takes a few seconds to build the website. From your Flink source directory:

git fetch https://github.com/uce/incubator-flink.git new_docs && git checkout FETCH_HEAD && ./docs/build_docs.sh -p

Now open your browser at http://localhost:4000

@tillrohrmann
Copy link
Contributor

I like the new docs layout :-)

@rmetzger
Copy link
Contributor

It looks much better. I'm +1 for merging it immediately like this. Once its merged, I would propose to make some minor changes:

  • The "beta" badge is not separated clearly enough from the rest of the text
  • I'm missing some space at the end of each page
  • It would be cool to have the version somewhere prominent (navbar?)

@hsaputra
Copy link
Contributor

+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.
Copy link
Contributor

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.

Copy link
Contributor

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.

@rmetzger
Copy link
Contributor

Why did you remove the Disqus comments from the pages?

@uce
Copy link
Contributor Author

uce commented Apr 22, 2015

Addressed:

  • Move Flink on Tez under Setup, since programming a job is the same, deployment is different? => moved to setup
  • The "beta" badge is not separated clearly enough from the rest of the text => use badge and add to each beta page
  • It would be cool to have the version somewhere prominent (navbar?) => Added to overview link
  • I'm missing some space at the end of each page => OK
  • Disqus
  • Rebased and added Pyhton API links

Open:

  • Not sure if the whole internals section is better fit for the docs or the wiki, but this is a ML discussion => Let's start a discussion on dev@
  • Was it not possible to have the navigation on the left or was it a conscious choice to have it on the right? => It is possible, but it needed some hacking and I didn't want to spend more time. Will change it soonish.
  • "Programming guides" seems a bit too narrow for what it contains (e.g., Local/Cluster execution). Perhaps rename to "Usage"? => I didn't address this, because we had it as programming guide before. I would also address this on the ML.

Can someone check it out again and then merge.

@uce uce force-pushed the new_docs branch 3 times, most recently from 350cc07 to 41272cc Compare April 22, 2015 13:17
- 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
@ktzoumas
Copy link
Contributor

Good to merge

@asfgit asfgit closed this in f1ee90c Apr 22, 2015
thvasilo pushed a commit to thvasilo/flink that referenced this pull request Apr 24, 2015
- 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.
bhatsachin pushed a commit to bhatsachin/flink that referenced this pull request May 5, 2015
- 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.
@uce uce deleted the new_docs branch June 1, 2015 22:10
marthavk pushed a commit to marthavk/flink that referenced this pull request Jun 9, 2015
- 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
7 participants