From 1f32ef722e123ed596905924f63ad457d923736f Mon Sep 17 00:00:00 2001 From: Cristovao Cordeiro Date: Thu, 23 May 2024 09:36:46 +0200 Subject: [PATCH] chore: fix rocks terminology --- CONTRIBUTING.md | 6 +++--- README.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1acebb1e..a004e074 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: @@ -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:.rock docker-daemon:kratos:latest diff --git a/README.md b/README.md index 20f9a495..5c3f90c4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Kratos ROCKs +# Kratos rocks ![Latest Version](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcanonical%2Fkratos-rock%2Fmain%2Frockcraft.yaml&query=%24.version&label=Release&color=red) [![License](https://img.shields.io/github/license/canonical/kratos-rock?label=License)](https://github.com/canonical/kratos-rock/blob/main/LICENSE) @@ -7,11 +7,11 @@ [![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) -[ROCKs](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/#rocks-explanation) +[Rocks](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/#rocks-explanation) for [Kratos](https://github.com/ory/kratos). -This repository holds all the necessary files to build ROCKs for the -upstream Ory Kratos. The Kratos ROCK is used by +This repository holds all the necessary files to build rocks for the +upstream Ory Kratos. The Kratos rock is used by the [kratos-operator](https://github.com/canonical/https://github.com/canonical/kratos-operator) charm.