ClickHouse/website
Ivan Blinkov 361a27485d Some progress on documentation (#1942)
* update presentations

* CLICKHOUSE-2936: redirect from clickhouse.yandex.ru and clickhouse.yandex.com

* update submodule

* lost files

* CLICKHOUSE-2981: prefer sphinx docs over original reference

* CLICKHOUSE-2981: docs styles more similar to main website + add flags to switch language links

* update presentations

* Less confusing directory structure (docs -> doc/reference/)

* Minify sphinx docs too

* Website release script: fail fast + pass docker hash on deploy

* Do not underline links in docs

* shorter

* cleanup docker images

* tune nginx config

* CLICKHOUSE-3043: get rid of habrastorage links

* Lost translation

* CLICKHOUSE-2936: temporary client-side redirect

* behaves weird in test

* put redirect back

* CLICKHOUSE-3047: copy docs txts to public too

* move to proper file

* remove old pages to avoid confusion

* Remove reference redirect warning for now

* Refresh README.md

* Yellow buttons in docs

* Use svg flags instead of unicode ones in docs

* fix test website instance

* Put flags to separate files

* wrong flag

* Copy Yandex.Metrica introduction from main page to docs

* Yet another home page structure change, couple new blocks (CLICKHOUSE-3045)

* Update Contacts section

* CLICKHOUSE-2849: more detailed legal information

* CLICKHOUSE-2978 preparation - split by files

* More changes in Contacts block

* Tune texts on index page

* update presentations

* One more benchmark

* Add usage sections to index page, adapted from slides

* Get the roadmap started, based on slides from last ClickHouse Meetup

* CLICKHOUSE-2977: some rendering tuning

* Get rid of excessive section in the end of getting started

* Make headers linkable

* CLICKHOUSE-2981: links to editing reference - https://github.com/yandex/ClickHouse/issues/849

* CLICKHOUSE-2981: fix mobile styles in docs

* Ban crawling of duplicating docs

* Open some external links in new tab

* Ban old docs too

* Lots of trivial fixes in english docs

* Lots of trivial fixes in russian docs

* Remove getting started copies in markdown

* Add Yandex.Webmaster

* Fix some sphinx warnings

* More warnings fixed in english docs

* More sphinx warnings fixed

* Add code-block:: text

* More code-block:: text

* These headers look not that well

* Better switch between documentation languages

* merge use_case.rst into ya_metrika_task.rst

* Edit the agg_functions.rst texts

* Add lost empty lines

* Lost blank lines

* Add new logo sizes

* update presentations

* Next step in migrating to new documentation

* Fix all warnings in en reference

* Fix all warnings in ru reference

* Re-arrange existing reference

* Move operation tips to main reference

* Fix typos noticed by milovidov@

* Get rid of zookeeper.md

* Looks like duplicate of tutorial.html

* Fix some mess with html tags in tutorial

* No idea why nobody noticed this before, but it was completely not clear whet to get the data

* Match code block styling between main and tutorial pages (in favor of the latter)

* Get rid of some copypaste in tutorial

* Normalize header styles

* Move example_datasets to sphinx

* Move presentations submodule to website

* Move and update README.md

* No point in duplicating articles from habrahabr here

* Move development-related docs as is for now

* doc/reference/ -> docs/ (to match the URL on website)

* Adapt links to match the previous commit

* Adapt development docs to rst (still lacks translation and strikethrough support)

* clean on release

* blacklist presentations in gulp

* strikethrough support in sphinx

* just copy development folder for now

* fix weird introduction in style article

* Style guide translation (WIP)

* Finish style guide translation to English

* gulp clean separately

* Update year in LICENSE

* Initial CONTRIBUTING.md

* Fix remaining links to old docs in tutorial

* Some tutorial fixes

* Typo

* Another typo

* Update list of authors from yandex-team accoding to git log

* Fix diff with master

* couple fixes in en what_is_clickhouse.rst

* Try different link to blog in Russian

* Swap words

* Slightly larger line height

* CLICKHOUSE-3089: disable hyphenation in docs

* update presentations

* Fix copying of txt files

* update submodule

* CLICKHOUSE-3108: fix overflow issues in mobile version

* Less weird tutorial header in mobile version

* CLICKHOUSE-3073: skip sourcemaps by default

* CLICKHOUSE-3067: rename item in docs navigation

* fix list markup

* CLICKHOUSE-3067: some documentation style tuning

* CLICKHOUSE-3067: less laggy single page documentation

* update presentations

* YQL-3278: add some links to ClickHouse Meetup in Berlin on October 5, 2017

* Add "time series" keyword

* Switch link to next event

* Switch link to next event #2

* smaller font

* Remove Palo Alto link

* Add link to Success stories list

* better title

* Update index.html

* Update index.html

* Do not expect gulp in $PATH

* Add link to Beijing meetup

* ignore presentations

* introduce requirements.txt

* Apply hacks by bayonet@ using monkey patching

* Simplify and fix patching of "single" docs on Mac OS (it still has a bug on chunk borders though)

* remove hidden symbol

* s/2016–2017/2016–2018/g

* Add some place to put virtualenv

* mkdocs was missing from requirements.txt

* This way it hurts eyes less

* Change header layout + add flags

* yandex_fonts.css -> custom.css

* Larger docs logo

* Shorter link

* Link to home from logo

* Borrow some more styles from main page

* Tune some links

* Remove shadow

* Add header border

* Header font

* Better flag margin

* Improve single page mode

* Fix search results hover

* Fix some MarkDown errors

* Silence useless error

* Get rid of index.html's

* Enable syntax highlight

* Fix link label in ru

* More style fixes in documentation scripts
2018-02-21 21:44:33 +03:00
..
deprecated Removed unsupported functionality [#CLICKHOUSE-2]. 2017-11-18 05:34:00 +03:00
images CLICKHOUSE-2720: progress on website and reference (#886) 2017-06-20 17:19:03 +03:00
nginx Redirects and single_page -> single. 2018-02-16 21:30:31 +03:00
404.html CLICKHOUSE-2976: basic 404 page 2017-05-16 19:48:59 +03:00
benchmark.html Added disclaimer for benchmark page 2017-12-27 23:02:42 +03:00
Dockerfile CLICKHOUSE-2724: website refactoring (#668) 2017-04-10 17:24:53 +03:00
favicon.ico CLICKHOUSE-2724: website refactoring (#668) 2017-04-10 17:24:53 +03:00
google419fbd824d7ff97d.html CLICKHOUSE-2724: website refactoring (#668) 2017-04-10 17:24:53 +03:00
gulpfile.js Sitemaps. 2018-02-13 17:11:45 +03:00
index.css Switch links to next event (#1332) 2017-10-11 14:19:17 +03:00
index.html Some progress on documentation (#1942) 2018-02-21 21:44:33 +03:00
jquery.js CLICKHOUSE-2724: website refactoring (#668) 2017-04-10 17:24:53 +03:00
README.md Miscellaneous [#CLICKHOUSE-3]. 2017-10-09 01:53:38 +03:00
release.sh Some progress on website and docs (#1717) 2017-12-29 18:45:21 +03:00
robots.txt Sitemaps. 2018-02-13 17:11:45 +03:00
setup_gulp.sh CLICKHOUSE-2724: website refactoring (#668) 2017-04-10 17:24:53 +03:00
sitemap.xml Sitemaps. 2018-02-13 17:11:45 +03:00
tutorial.html Some progress on documentation (#1942) 2018-02-21 21:44:33 +03:00
yandex_fffaa30ee00426bb.html CLICKHOUSE-2720: progress on website (#865) 2017-06-13 07:15:47 +03:00

ClickHouse website quickstart:

On Linux, do the following:

sudo apt-get install nodejs
sudo ln -s /usr/bin/nodejs /usr/bin/node
sudo npm install gulp-cli -g
sudo npm install gulp -D
  1. Make sure you have npm, docker and python installed and available in your $PATH.
  2. Run setup\_gulp.sh once to install build prerequisites via npm.
  3. Use gulp build to minify website to "public" subfolder or just gulp to run local webserver with livereload serving it (note: livereload browser extension is required to make it actually reload pages on edits automatically).
  4. There's Dockerfile that can be used to build and run ClickHouse website inside docker.
  5. Deployment to https://clickhouse.yandex/ is managed by release.sh, but it is only usable from inside Yandex private network.