このプロジェクトには、検証済みpatterns.io のドキュメントサイトが新たに作成されています。

コンテナイメージを使用して、検証済みのパターンのドキュメントをローカルで作成します。 コンテナイメージを使用してドキュメントをプレビューします。 これは、ローカルプレビューが展開パイプラインでレンダリングされているものと同じであることを確認することをお勧めします。

また、このサイトをHugoとAsciidoctorを使って構築することもできます。

Hugoをインストール

さまざまなプラットフォーム(Linux、Windows、macOS)に複数のメソッドを使用してHugoをインストールできます。 目的のプラットフォームにHugoをインストールする方法については、Hugoをインストールを参照してください。

##Asciidoctorをインストール

さまざまなプラットフォーム(Linux、Windows、macOS)にAsciidoctorをインストールできます。 目的のプラットフォームにAsciidoctorをインストールする方法の詳細については、Asciidoctorをインストールを参照してください。

Hugo を使用してウェブサイトをローカルにデプロイする

ローカルサーバとしてHugoを実行して、サイトをテストすることができます。

1。 このリポジトリをローカルリポジトリとしてクローン化します。

2. ローカルリポジトリの変更

3. 次のコマンドを実行します。

$ hugo サーバー

4。 [http://localhost:1313/]でブラウザのサイトを表示します。

AI ツール

####AGENTS.mdの

このリポジトリには AGENTS が含まれています.

Validated Patterns documentation site

This project contains the new proof-of-concept documentation site for validatedpatterns.io.

Use a container image to build the Validated Patterns documentation, locally. See Preview the documentation using a container image. This is recommended to ensure the local preview is the same as what is rendered in deployment pipelines.

Alternatively, you can build this site using Hugo and Asciidoctor.

Install Hugo

You can install Hugo on different platforms (Linux, Windows, macOS) using a number of methods. For more information on how to install Hugo on your desired platform, see Install Hugo.

Install Asciidoctor

You can install Asciidoctor on different platforms (Linux, Windows, macOS) using a number of methods. For more information on how to install Asciidoctor on your desired platform, see Install Asciidoctor.

Deploy the website locally using Hugo

You can run Hugo as a local server to test out the site.

1. Clone this repository as a local repository.

2. Change to the local repository.

3. Run the following command:

    $ hugo server
   

4. View the site on your browser at http://localhost:1313/.

AI tooling

AGENTS.md

This repository includes an AGENTS.md file that helps AI agents understand the structure, tooling, and conventions of the repository so they can make correct, buildable changes. It covers the repository layout, build commands, content authoring conventions, frontmatter schemas, and style guidelines.

AI documentation skills

The repository also includes AI agent skills for creating and reviewing documentation, located in .rulesync/skills/. These skills are synced to your editor using rulesync.

Available skills

• doc-create – Create new learn pages or pattern page sets with correct structure and style-compliant content.
• doc-review – Review existing documentation files against 24 Red Hat/IBM style guide rules, with format-aware checking for AsciiDoc and Markdown.

Prerequisites for installing AI skiils

• Node.js and npm

• rulesync installed globally:

    $ npm install -g rulesync
  

Generating skills for your editor

To sync the skills to Cursor:

    $ rulesync generate --targets cursor --features skills

To sync the skills to Claude Code:

    $ rulesync generate --targets claudecode --features skills

To sync to both at once:

    $ rulesync generate --targets cursor claudecode --features skills