Skip to content

Commit

Permalink
fix: update make targets and docs (#41)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Adriel Perkins <[email protected]>
  • Loading branch information
caseyw and adrielp authored Feb 9, 2024
1 parent 6dc4bab commit 8c7ce88
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 14 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ build: poetry-install
poetry run mkdocs build

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

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

.PHONY: backstage
Expand Down
44 changes: 33 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,47 @@
# 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.
If you're looking to contribute, please see the
[contributing](./docs/contributing.md) documentation.

## Local Development

### MkDocs
### Prerequisites

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

- Follow the guidelines established in [CONTRIBUTING.md](docs/CONTRIBUTING.md)
- Images should be placed under the root `img` folder and referred to using HTML `<img>` tags
- Images should be placed under the root `img` folder and referred to using
HTML `<img>` tags
- H3 header (`###`) should be the default header within a page
- H2 header (`##`) will appear in the navigation as the page's table of contents
- H2 header (`##`) will appear in the navigation as the page's table of
contents
- make sure to add to _sidebar

0 comments on commit 8c7ce88

Please sign in to comment.