Upsun Developer Center

Running locally

Option 1: Quickstart

Requirements:

• Hugo

Steps:

• Clone this repository: git clone [email protected]:upsun/devcenter.git && cd devcenter/dev
• git submodule init
• git submodule update
• npm install
• hugo serve

Option 2: Replicate production

• Start Docker
• git submodule init
• git submodule update
• docker-compose up --remove-orphans

Visit the site at http://localhost:1313.

Cleaning up:

• docker-compose down
• docker container prune

Running tests

Before merging a PR, it's a good idea to run the following tests.

1. Checking internal links

   ./tests/check_links/test.sh

2. Lint markdown/prose

   ./tests/check_lint/test.sh

3. (Scheduled) link checker

   ./tests/linkchecker/test.sh https://devcenter.upsun.com/

Handling dependencies

1. Testing for vulnerabilities

   ./tests/check_deps/test.sh

2. Upgrading dependencies

   ./tests/check_deps/upgrade.sh