https://github.com/kube-logging/kube-logging.github.io

Logging operator documentation
https://github.com/kube-logging/kube-logging.github.io

Last synced: 17 days ago
JSON representation

Logging operator documentation

• Host: GitHub
• URL: https://github.com/kube-logging/kube-logging.github.io
• Owner: kube-logging
• License: apache-2.0
• Created: 2020-03-02T15:00:21.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-06T13:32:05.000Z (19 days ago)
• Last Synced: 2025-01-06T14:33:23.910Z (19 days ago)
• Language: HTML
• Homepage: https://kube-logging.dev/
• Size: 345 MB
• Stars: 6
• Watchers: 11
• Forks: 54
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kube-logging.dev - Logging operator documentation

This repository is the source of the Logging operator documentation, published at [https://kube-logging.dev](https://kube-logging.dev).

The documentation is built using [Hugo](https://gohugo.io/) and the [Docsy theme](https://www.docsy.dev/docs/).

## Using this repository

You can run the website locally using Hugo (Extended version).

To use this repository, you need the following installed locally:

- [npm](https://www.npmjs.com/)

- [Go](https://go.dev/)

- [Hugo (Extended version)](https://gohugo.io/)

1. Install the dependencies. Clone the repository and navigate to the directory:

    ```bash

    git clone https://github.com/kube-logging/kube-logging.github.io/

    cd kube-logging.github.io

    ```

1. The Logging operator website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme). Pull in the submodule:

    ```shell

    git submodule update --init --recursive --depth 1

    ```

1. Install the dependencies of Docsy:

    ```shell

    cd themes/docsy

    npm install

    cd ../../

    ```

1. Run the website locally using Hugo:

    ```shell

    hugo serve

    ```

    This starts the local Hugo server, by default on port 1313 (or another one if this port is already in use). Open `http://localhost:1313` in your browser to view the website. As you make changes to the source files, Hugo automatically updates the website and refreshes the browser.

    Common build errors:

    - `error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version`: You have installed the regular version of Hugo, not the extended version.

    - `execute of template failed: template: docs/single.html:30:7: executing "docs/single.html" at : error calling partial`: You haven't run `npm install` in the `themes/docsy` directory.