DEVELOPMENT.md 1.6 KB
Newer Older
M
michaelawyu 已提交
1 2
# Developing the Tekton website

3 4 5
- [Developing the Tekton website](#developing-the-tekton-website)
  - [Running Locally](#running-locally)
  - [tekton.dev](#tektondev)
M
michaelawyu 已提交
6

7
## Running Locally
M
michaelawyu 已提交
8 9


10 11
The [tekton.dev](#tekton.dev) is deployed on Netlify. Netlify will invoke
[the Makefile](.Makefile) to build the website.
M
michaelawyu 已提交
12

13
This is configured in:
M
michaelawyu 已提交
14

15 16 17
* [netlify.toml](netlify.toml)
* [runtime.txt](runtime.txt) (the python runtime)
* [requirements.txt](requirements.txt) (the python requirements)
M
michaelawyu 已提交
18

19
To run it locally you will need to install:
M
michaelawyu 已提交
20

21 22 23
* [Hugo](https://gohugo.io/) [version 0.53](netlify.toml)
* `npm` to install Hugo's requirements:
  * `npm install` (in directory with [package.json](package.json))
M
michaelawyu 已提交
24

25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
Then you can run [hugo commands](https://gohugo.io/getting-started/usage/) such as:

```bash
hugo server
```

To run the [Makefile](Makefile) you will need more dependencies and flags:

* `python` aliased to python3.7 - [sync.py](sync/sync.py) is running `python` but assumes this is python3 (configured in [runtime.txt](runtime.txt))
* `pip`, to install python requirements:
  * Install with `pip install -r requirements.txt`

To run the makefile locally, you'll have to set the env var:

* [`DEPLOY_PRIME_URL`](https://docs.netlify.com/configure-builds/environment-variables/) to the path to your website files

For example:

```bash
44
DEPLOY_PRIME_URL=localhost make preview-build
45 46 47 48
```

## tekton.dev

49 50
- The latest website is available at [https://tekton.dev/](https://tekton.dev/).
- The old website is available at [https://tekton-old.netlify.app/](https://tekton-old.netlify.app/) and based on the [website-old](https://github.com/tektoncd/website/tree/website-old) branch.