« Conditions of use Building documentation »
Elastic Docs ›Docs HOWTO

Getting started

edit

Getting started

edit

Requirements

edit

You’ll need the following installed:

  • Python 3
  • Docker

Cloning the repository

edit

Clone the docs repository with:

git clone git@github.com:elastic/docs.git

Building this README

edit

You can test that everything is working correctly by building this README as follows:

The following static resources needs to be fetched from Docker manually though:

  • styles.css (now it’s style-v1.css, looks like a temp file by upstream, might change in the fugure)
  • docs.js (now it’s docs-v1.js, looks like a temp file by upstream, might change in the fugure)
  • jquery.js
  • fonts

They are currently hosted at my profile repo

To update those static resources manually, use the following command and copy & paste the contents from Docker container to host server or simply download it from container’s running http://localhost:8000

./build_docs --doc README.asciidoc --open

This should convert README.asciidoc into HTML and open it in your browser.

« Conditions of use Building documentation »