Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
108 lines (71 loc) · 2.81 KB

DEVELOPMENT.md

File metadata and controls

108 lines (71 loc) · 2.81 KB

Developing the Tekton website

Running in a Docker container

Prerequisites

Install Docker Compose.

Setup

  1. Build the Docker image

    docker-compose build

  2. Run the built image

    docker-compose up

  3. 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.

To remove the produced images run:

docker-compose rm

Running Natively

Prerequisites

Please use the exact versions specified here otherwise npm start will fail.

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

    npm start

  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.

To debug issues only present in the production build, you can run the Netlify production build locally:

URL=http://localhost:8888 npx netlify serve

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.

tekton.dev