ClickHouse/website
Ivan Blinkov 9257e6597d
WIP on docs (#3753)
* CLICKHOUSE-4063: less manual html @ index.md

* CLICKHOUSE-4063: recommend markdown="1" in README.md

* CLICKHOUSE-4003: manually purge custom.css for now

* CLICKHOUSE-4064: expand <details> before any print (including to pdf)

* CLICKHOUSE-3927: rearrange interfaces/formats.md a bit

* CLICKHOUSE-3306: add few http headers

* Remove copy-paste introduced in #3392

* Hopefully better chinese fonts #3392

* get rid of tabs @ custom.css

* Apply comments and patch from #3384

* Add jdbc.md to ToC and some translation, though it still looks badly incomplete

* minor punctuation

* Add some backlinks to official website from mirrors that just blindly take markdown sources

* Do not make fonts extra light

* find . -name '*.md' -type f | xargs -I{} perl -pi -e 's//g' {}

* find . -name '*.md' -type f | xargs -I{} perl -pi -e 's/ sql/g' {}

* Remove outdated stuff from roadmap.md

* Not so light font on front page too

* Refactor Chinese formats.md to match recent changes in other languages

* Update some links on front page

* Remove some outdated comment

* Add twitter link to front page

* More front page links tuning

* Add Amsterdam meetup link

* Smaller font to avoid second line

* Add Amsterdam link to README.md

* Proper docs nav translation

* Back to 300 font-weight except Chinese

* fix docs build

* Update Amsterdam link

* remove symlinks

* more zh punctuation

* apply lost comment by @zhang2014

* Apply comments by @zhang2014 from #3417

* Remove Beijing link

* rm incorrect symlink

* restore content of docs/zh/operations/table_engines/index.md

* CLICKHOUSE-3751: stem terms while searching docs

* CLICKHOUSE-3751: use English stemmer in non-English docs too

* CLICKHOUSE-4135 fix

* Remove past meetup link

* Add blog link to top nav

* Add ContentSquare article link

* Add form link to front page + refactor some texts

* couple markup fixes

* minor

* Introduce basic ODBC driver page in docs

* More verbose 3rd party libs disclaimer

* Put third-party stuff into a separate folder

* Separate third-party stuff in ToC too

* Update links

* Move stuff that is not really (only) a client library into a separate page

* Add clickhouse-hdfs-loader link

* Some introduction for "interfaces" section

* Rewrite tcp.md

* http_interface.md -> http.md

* fix link

* Remove unconvenient error for now

* try to guess anchor instead of failing

* remove symlink

* Remove outdated info from introduction

* remove ru roadmap.md

* replace ru roadmap.md with symlink

* Update roadmap.md

* lost file

* Title case in toc_en.yml

* Sync "Functions" ToC section with en

* Remove reference to pretty old ClickHouse release from docs

* couple lost symlinks in fa

* Close quote in proper place

* Rewrite en/getting_started/index.md

* Sync en<>ru getting_started/index.md

* minor changes

* Some gui.md refactoring

* Translate DataGrip section to ru

* Translate DataGrip section to zh

* Translate DataGrip section to fa

* Translate DBeaver section to fa

* Translate DBeaver section to zh

* Split third-party GUI to open-source and commercial

* Mention some RDBMS integrations + ad-hoc translation fixes

* Add rel="external nofollow" to outgoing links from docs

* Lost blank lines

* Fix class name

* More rel="external nofollow"

* Apply suggestions by @sundy-li

* Mobile version of front page improvements

* test

* test 2

* test 3

* Update LICENSE

* minor docs fix

* Highlight current article as suggested by @sundy-li
2018-12-07 19:24:54 +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 WIP on docs/website (#3383) 2018-10-16 13:47:17 +03:00
404.html CLICKHOUSE-2976: basic 404 page 2017-05-16 19:48:59 +03:00
benchmark.html Removed wrong code from StorageSystemColumns #2447 2018-09-03 21:04:29 +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 Copy pdfs via gulp too 2018-10-12 18:53:40 +03:00
index.css WIP on docs (#3753) 2018-12-07 19:24:54 +03:00
index.html WIP on docs (#3753) 2018-12-07 19:24:54 +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 s/ch/zh/g as it is the correct ISO code 2018-10-08 13:24:34 +03:00
setup_gulp.sh CLICKHOUSE-2724: website refactoring (#668) 2017-04-10 17:24:53 +03:00
sitemap_static.xml Fixing sitemaps (#3053) 2018-09-06 01:09:58 +03:00
sitemap.xml s/ch/zh/g as it is the correct ISO code 2018-10-08 13:24:34 +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.