【入門編】GitLab「Static Site Editor」を導入!非エンジニアがMarkdown知識ゼロで記事投稿できるワークフロー – バージョン管理・CI/CD活用バイブル

エンジニアの皆さん、こんにちは。現場で「ちょっとこのドキュメントの文言直しておいて」と非エンジニアから頼まれ、本来やるべき開発の手を止められた経験はありませんか?

その「割り込み作業」、GitLabのStatic Site Editor (SSE)を使えば、もうエンジニアの仕事ではなくなります。

今回は、非エンジニアがMarkdownの知識ゼロで記事を投稿・編集し、開発チームは承認ボタンを押すだけでサイトが更新される——そんな「究極の省力化ワークフロー」を構築するノウハウを伝授します。

—

1. なぜ「Static Site Editor」なのか?

一般的に、静的サイトの更新にはGit操作やCLIの知識が必須です。しかし、SSEを導入すれば、GitLabのUI上でWYSIWYG(見たまま編集)エディタが提供されます。

  • エンジニアのメリット: プルリクエスト(マージリクエスト)の管理から解放され、本来の開発タスクに集中できる。
  • 非エンジニアのメリット: GitコマンドやMarkdownを覚える必要がなく、Word感覚で記事が書ける。

GitLab Pagesと組み合わせることで、「編集 → 自動プレビュー → 承認 → 公開」というプロフェッショナルなCI/CDパイプラインを誰でも利用できるようになります。

—

2. 最短で構築する:セットアップの核心

まずは、GitLab Pagesでサイトが公開されている前提で、以下の設定を行います。

ステップ1: `static_site_editor.yml` の配置

プロジェクトのルートディレクトリに `.gitlab/` フォルダを作成し、その中に `static_site_editor.yml` を配置します。これがSSEの司令塔です。

.gitlab/static_site_editor.yml
エディタの挙動を制御する設定ファイルです
edit_url: ‘/edit-content’ # 編集画面のベースURL
どのファイルを編集可能にするかのパターン指定
allowed_files:

  • ‘content/posts/.md’

ステップ2: CI/CDパイプラインへの組み込み

`.gitlab-ci.yml` にプレビュー環境用の設定を追加します。ここが「震えるほど便利な」ポイントです。

.gitlab-ci.yml
pages:
stage: deploy
script:

  • ./build_site.sh # あなたのビルドスクリプト

artifacts:
paths:

  • public

only:

  • main

SSE専用のプレビュー機能:これが非エンジニアの救世主
preview:
stage: test
script:

  • ./build_preview.sh

only:

  • merge_requests

—

3. Hello World:運用の流れ

セットアップが終われば、現場の運用は劇的に変わります。

1. 直感的な編集: 非エンジニアが対象のMarkdownファイルを開き、「Edit」ボタンを押す。
2. WYSIWYGエディタ: 見たまま編集画面が表示される。Markdownの記法を気にせず、太字やリンクを設定可能。
3. MRの自動生成: 「Save changes」を押すと、自動的にブランチが切られ、マージリクエストが作成される。
4. プレビュー確認: MRのページに「View App」ボタンが現れる。反映後の見た目をエンジニアの手を借りずに確認できる。
5. 承認とマージ: エンジニアは内容を見て「Approve & Merge」を押すだけ。CI/CDが走って本番に反映される。

—

4. 現場で役立つ「極限の知見」:ここがプロの分かれ道

単にツールを入れるだけでは不十分です。以下の工夫で、運用はさらに安定します。

  • CODEOWNERSの活用:

マーケティングチームの編集内容は「マーケティング担当者」が承認し、技術的なドキュメントは「エンジニア」が承認するよう `CODEOWNERS` ファイルでルール化しましょう。これにより、誤った情報の公開を自動的に防げます。

  • テンプレートの固定:

非エンジニアが崩さないよう、Front Matter(メタデータ)の入力項目を制限する工夫が必要です。HugoやJekyllを使っている場合、必要なパラメータだけを埋め込めるカスタムテンプレートを用意しておくのが、最大の「優しさ」です。

—

最後に:エンジニアの価値は「仕組み」にある

「ドキュメントの修正」という作業は、自動化の余地が最も大きい場所の一つです。

GitLab SSEの導入は、単なるツールの導入ではありません。「誰でもコンテンツを公開できる環境を整える」という、DevOpsの文化そのものの導入です。

これをマスターすれば、あなたのチームから「あの修正まだ終わらないの?」というストレスは消滅します。さあ、今すぐプロジェクトに組み込んで、チームを次のステージへ引き上げましょう。

何か不明点があれば、またいつでも聞いてください。応援していますよ!

タイトルとURLをコピーしました