Skip to content

Commit c2586e4

Browse files
Create README.md
1 parent 7330359 commit c2586e4

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# kube-logging.github.io - Logging operator documentation
2+
3+
This repository is the source of the Logging operator documentation, published at [https://kube-logging.github.io](https://kube-logging.github.io/docs/).
4+
5+
The documentation is built using [Hugo](https://gohugo.io/) and the [Docsy theme](https://www.docsy.dev/docs/)
6+
7+
## Using this repository
8+
9+
You can run the website locally using Hugo (Extended version).
10+
11+
### Prerequisites
12+
13+
To use this repository, you need the following installed locally:
14+
15+
- [npm](https://www.npmjs.com/)
16+
- [Go](https://go.dev/)
17+
- [Hugo (Extended version)](https://gohugo.io/)
18+
19+
Before you start, install the dependencies. Clone the repository and navigate to the directory:
20+
21+
```bash
22+
git clone https://github.com/kubernetes/website.git
23+
cd website
24+
```
25+
26+
The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme). Even if you plan to run the website in a container, we strongly recommend pulling in the submodule and other development dependencies by running the following:
27+
28+
### Windows
29+
```powershell
30+
# fetch submodule dependencies
31+
git submodule update --init --recursive --depth 1
32+
```

0 commit comments

Comments
 (0)