ClickHouse/website
Ivan Blinkov c7e526e050
WIP on documentation (#2692)
* Additional .gitignore entries

* Merge a bunch of small articles about system tables into single one

* Merge a bunch of small articles about formats into single one

* Adapt table with formats to English docs too

* Add SPb meetup link to main page

* Move Utilities out of top level of docs (the location is probably not yet final) + translate couple articles

* Merge MacOS.md into build_osx.md

* Move Data types higher in ToC

* Publish changelog on website alongside documentation

* Few fixes for en/table_engines/file.md

* Use smaller header sizes in changelogs

* Group up table engines inside ToC

* Move table engines out of top level too

* Specificy in ToC that query language is SQL based. Thats a bit excessive, but catches eye.

* Move stuff that is part of query language into respective folder

* Move table functions lower in ToC

* Lost redirects.txt update

* Do not rely on comments in yaml + fix few ru titles

* Extract major parts of queries.md into separate articles

* queries.md has been supposed to be removed

* Fix weird translation

* Fix a bunch of links

* There is only table of contents left

* "Query language" is actually part of SQL abbreviation

* Change filename in README.md too

* fix mistype

* s/formats\/interfaces/interfaces\/formats/g

* Remove extra clarification from header as it was too verbose, probably making it a bit more confusing

* Empty article was supposed to be hidden

* At least change incorrect title

* Move special links to the bottom of nav and slightly highlight them

* Skip hidden pages in bottom navigation too

* Make front page of documentation to be part of Introduction

* Make tables in introduction somewhat readable + move abbreviation definitions earlier

* Some introduction text refactoring

* Some docs introduction refactoring

* Use admonitions instead of divs

* Additional .gitignore

* Treat .gif as images too

* Clarify ToC item
2018-07-20 20:35:34 +03:00
..
deprecated Squashed #2471 2018-06-05 23:09:51 +03:00
images CLICKHOUSE-2720: progress on website and reference (#886) 2017-06-20 17:19:03 +03:00
nginx Refactoring of documentation infrastructure to get rid of a lots of copypaste (#2616) 2018-07-09 22:59:07 +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 WIP on documentation (#2692) 2018-07-20 20:35:34 +03:00
index.css Added links to the meetups [#CLICKHOUSE-3] 2018-03-30 00:11:56 +03:00
index.html Some WIP on documentation refactoring (#2659) 2018-07-18 13:00:53 +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 Add Berlin meetup link & update roadmap (#2491) 2018-06-09 15:21:45 +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 Writing changelog (#2215) 2018-04-17 23:57:02 +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.