Skip to content

Commit

Permalink
fix: cleanup some docs and simplified make targets
Browse files Browse the repository at this point in the history
  • Loading branch information
caseyw committed Feb 8, 2024
1 parent 9a1d451 commit 1e1184b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 14 deletions.
9 changes: 3 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,11 @@ build: poetry-install
poetry run mkdocs build

.PHONY: serve
serve:
serve: poetry-install
poetry run mkdocs serve

.PHONY: install-deps
install-deps: install-main-deps poetry-install

.PHONY: install-main-deps
install-main-deps:
.PHONY: brew
brew:
brew bundle --force

.PHONY: backstage
Expand Down
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
# openo11y.dev

Welcome to Open O11y! This repository hosts the website files for [openo11y.dev](https://openo11y.dev), an open-source public website with guidance and information on observability (o11y).
Welcome to OpenO11y! This repository hosts the website files for [openo11y.dev](https://openo11y.dev), an open-source public website dedicated to providing guidance and resources on observability (o11y).

If you're looking to contribute, please see the [contributing](./docs/contributing.md) documentation.

## Local Development

### MkDocs
### Tooling

The site is built using `mkdocs`. You can serve the site locally by running
The following tools will need to be installed:

```sh
make install-deps
make build
make serve
```
- [Make](https://www.gnu.org/software/make/): A build automation tool.
- [Python](https://www.python.org/downloads/): The programming language used for development.
- [Poetry](https://python-poetry.org/docs/#installation): A tool for dependency management in Python.

Note: OSX users with [Homebrew](https://brew.sh/) installed can install Poetry by running the command `make brew`.

### Working on Documentation

Our site is built using [mkdocs](https://www.mkdocs.org/), a static site generator optimized for project documentation. It features
hot reloading, allowing immediate preview of changes, and can compile documentation into static assets for deployment.

To work on the documentation:

- Use `make serve` to start a local server. Your changes can be viewed in real-time at http://127.0.0.1:8000.
- To build the documentation, run `make build`. This command generates static files and stores them in the `./site` directory.

## Contributing

Expand Down

0 comments on commit 1e1184b

Please sign in to comment.