Skip to content

Update README instructions to serve documentation #446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbpros merged 1 commit into from
Feb 20, 2025
Merged

Update README instructions to serve documentation #446

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
This CLI is used to report DevOps change events to Kosli and query them.

## Status

Kosli is still in beta

## Usage
Expand All @@ -22,12 +23,9 @@ See the [docs](https://docs.kosli.com/client_reference/)

## Building the documentation

If building the docs for the first time, the submodule for the theme should be initialized:
`git submodule update --init --recursive`

then:
`make hugo`
`make hugo-local`
Copy link
Contributor

@FayeSGW FayeSGW Feb 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to have the hugo mod init command included? Or did it end up not being needed?

Copy link
Contributor Author

@jbpros jbpros Feb 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jumboduck confirmed it's not needed. Indeed, simply running make hugo-local builds and serves the docs just fine on my machine.


## Running the tests

To run only the tests in a single test suite, eg TestAttestJunitCommandTestSuite
`make test_integration_single TARGET=TestAttestJunitCommandTestSuite`