Building on Ubuntu

Building Docs for development using Ubuntu

We strongly recommend Ubuntu 20.04 (Focal Fossa) or later; updating Python is annoying. For more details on configuring sources and working with docs, please refer to the README

1. Install Git

   sudo apt install git

2. Clone repo

   git clone https://github.com/EnterpriseDB/docs.git ~/git/docs

3. If running Ubuntu 19 or later, you'll already have a sufficiently new version of Python! If older Ubuntu, get Python 3.6 or higher.
4. Install nvm

   wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash 

   (see https://github.com/nvm-sh/nvm for details)
5. Close and reopen terminal
6. Change CWD to the location where you cloned the docs repo in step #2

   cd ~/git/docs

7. Use nvm to install the version of NodeJS required by the repo

   nvm install

8. Use npm to install gatsby and yarn

   npm i -g gatsby-cli
   npm i -g yarn

9. Use yarn to install required packages

   yarn

10. Pull down shared icon files

    git submodule update --init

11. Select sources: you can choose none, or many by typing the ID of the sources separated by commas when prompted. For example, 1d,1l to select EPAS and PEM

    yarn config-sources

12. Pull the sources selected in step #12

    yarn pull-sources

    (respond with y when prompted) Re-run this command at any time to build the latest sources. For product docs, run git pull
13. Build and run!

    yarn develop