Skip to content

Commit

Permalink
chore: fix rocks terminology
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdcordeiro committed May 23, 2024
1 parent f353737 commit a00c278
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Please refer to
the [rockcraft](https://canonical-craft-parts.readthedocs-hosted.com/en/latest/reference/index.html)
documentations to learn how to develop a ROCK image.
documentations to learn how to develop a rock.

Please install `pre-commit` hooks to help enforce various validations:

Expand All @@ -14,14 +14,14 @@ pre-commit install -t commit-msg

## Building and Running Locally

You can build the ROCK image using the following command:
You can build the rock using the following command:

```shell
rockcraft pack -v
```

Assuming the [`skopeo`](https://snapcraft.io/install/skopeo/ubuntu) has been
installed. Import the created ROCK image into Docker:
installed. Import the created rock into Docker:

```shell
sudo /snap/rockcraft/current/bin/skopeo --insecure-policy copy oci-archive:<local-rock-name>.rock docker-daemon:openfga:latest
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OpenFGA ROCK
# OpenFGA rock

[![Container Registry](https://img.shields.io/badge/Container%20Registry-published-blue)](https://github.com/canonical/openfga-rock/pkgs/container/openfga)
![Latest Version](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcanonical%2Fopenfga-rock%2Fmain%2Frockcraft.yaml&query=%24.version&label=Release&color=red)
Expand All @@ -8,14 +8,14 @@
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196.svg)](https://conventionalcommits.org)

This repository contains the packaging metadata for creating an OpenFGA ROCK
built from Canonical OpenFGA release artifacts. For more information on ROCKs,
This repository contains the packaging metadata for creating an OpenFGA rock
built from Canonical OpenFGA release artifacts. For more information on rocks,
visit the [rockcraft GitHub](https://github.com/canonical/rockcraft).

## Building the ROCK
## Building the rock

The steps outlined below are based on the assumption that you are building the
ROCK with the latest LTS of Ubuntu. If you are using another version of Ubuntu
rock with the latest LTS of Ubuntu. If you are using another version of Ubuntu
or another operating system, the process may be different.

### Clone Repository
Expand Down Expand Up @@ -44,7 +44,7 @@ sudo lxd init --auto
**NOTE:** You will need to open a new shell for the group change to take
effect (i.e. `su - $USER`)

### Packing and Running the ROCK
### Packing and Running the rock

```shell
rockcraft pack
Expand All @@ -54,5 +54,5 @@ docker run --rm -it <username>/openfga:<tag>

## License

The OpenFGA ROCK is free software, distributed under the Apache Software
The OpenFGA rock is free software, distributed under the Apache Software
License, version 2.0. See [LICENSE](./LICENSE) for more information.

0 comments on commit a00c278

Please sign in to comment.