Run the site locally

Running in a Docker container

1. Install Docker Compose.

2. Build the Docker image:

   docker-compose build
   

3. Run the built image:

   docker-compose up
   

4. Verify that the website is working. Open your web browser and type http://localhost:8888 in the navigation bar. This opens a local instance of the website, you can now make changes in the documentation and those changes will immediately show up in the browser after you save.

5. Hit Ctrl + C to stop the container.

To remove the produced images run:

docker-compose rm

Running Natively

Prerequisites

• python3
• hugo (EXTENDED VERSION)
• pip
• git 1.8.5 or later
• npm v6.14.5
• node v14.3.0
• netlify cli
• netlify account

Setup

1. Clone the repository

   git clone https://github.com/tektoncd/website && cd website
   

2. Install the required node modules

   npm install
   

3. Install the dependencies for the sync script

   python3 -m venv .venv
   source .venv/bin/activate    
   pip3 install -r requirements.txt
   

4. Run the sync script

   ./sync/sync.py
   

5. Serve the website locally

   netlify dev
   

6. Verify that the website is working

   Open your web browser and type http://localhost:8888 in the navigation bar. This opens a local instance of the website, you can now make changes in the documentation and those changes will immediately show up in the browser after you save.

The sync.py script clones the required repositories to a local cache folder, by default sync/.cache. You can modify content and create commits in your local cache to test changes to the original docs.

To force and update of the local cache, use ./sync/sync.py --update-cache.