Hugo でプロダクトのドキュメントサイトを構築する

業務でプロダクトのドキュメントを Hugo で作成したので、メモを残しておきます。

  • Hugo とは
  • 使用したテーマ(Hextra)
  • 構築
    • セットアップ
      • Hugo インストール
      • プロジェクト作成
      • コンテンツ追加
    • Hugo の config 設定
    • コンテンツを充実させる
      • ドキュメントタイプのレイアウトにする
      • ショートコードによるコンテンツ埋め込み
        • コールアウト
        • カード
        • Youtube
      • 固定された文言を変更する
    • GitLab Pages へのデプロイ
  • おわりに
続きを読む

ネスト構造をもつドキュメントの検索

OpenSearch はさまざまな構造のデータを登録・検索することができます。
その中には、ネスト構造を持つドキュメントもあるかと思います。
そういったドキュメントの検索方法についてみていきます。

目次

  • ネスト構造を持つドキュメントって?
  • nested フィールド
  • 複数ページあるドキュメント内の検索
  • おわりに
続きを読む

Search Template を使った検索

OpenSearch で検索する際のクエリは量が多く複雑になりがちです。そんな時に Search Template が便利です。

目次

  • Search Template
  • Search Template に関する便利API
    • Search Template 登録
    • Search Template を使用した検索
    • Search Template のレンダリング
    • 登録前の Search Template を使った検索
    • 登録した Search Template 一覧取得
    • 登録済みの Search Template の取得
    • Search Template の削除
  • おわりに
続きを読む

OpenSearch アナライザーをカスタマイズする

OpenSearch で登録、検索する際、アナライザーがテキストを解析しています。
アナライザーの設定次第で柔軟な検索が可能になります。

目次

  • アナライザーによるテキスト解析
  • 日本語向けアナライザー
  • アナライザーのカスタマイズ
    • アナライザーの構成要素
    • ICU の機能
    • kuromoji の機能
    • N-gram tokenizer
    • カスタムしたアナライザーを利用した検索
      • kuromoji ベース
      • Ngram
  • おわりに
続きを読む

Go でテストを書く

Go でテストを書くとき、private 定義しているものの扱いについてちょっとしたコツです。

目次

  • Goでのpublic/private
  • export_test.go
    • 変数, 定数
    • 関数
    • 構造体
    • 構造体のメソッド
    • インタフェース
  • おわりに
続きを読む

OpenSearch に登録したドキュメントの検索

OpenSearch に登録したドキュメントの検索クエリについて見ていきます。

OpenSearch を利用したことがない方や、構築して実際に動かして見たい方は、OpenSearch で全文検索:OpenSearch 構築、基本操作をご覧ください。

目次

  • テストデータ登録
  • 検索する
    • キーワード検索
    • 複数フィールドに対する検索
    • AND検索
    • OR検索
    • フィルタリング
    • レスポンスに含める項目の制御
    • ハイライト
    • 検索結果のソート
  • おわりに
続きを読む

OpenSearch 構築、基本操作

久々に OpenSearch を使用する機会があり、いろいろ忘れていたのでメモがてら書いていきます。

目次

  • OpenSearchとは
  • 構築
  • 基本用語
  • 基本操作
    • インデックス作成
    • ドキュメント登録
    • ドキュメント検索
  • おわりに
続きを読む