Skip to content

Braze Docsへの貢献

Braze Docsへの貢献に感謝します！毎週火曜日と木曜日に、コミュニティからの投稿をマージし、Braze Docsにデプロイします。このガイドを使用して、次回のデプロイ時に変更をマージしてください。

前提条件

Braze Docsに貢献するためには、Gitをある程度理解していることが必要です。Gitを使うのが初めてで何から始めたらいいのかわからない場合は、[Git Bookをご覧ください：開始復習が必要な場合は、GitとGitHubを参照してください。

ステップ 1:CLAに署名する

Braze Docsに貢献するすべての人は、貢献ライセンス契約（CLA）に署名しなければなりません。CLAに署名しないと、GitHubの@cla-bot 、自動的にプルリクエストがブロックされます。

ステップ 2:環境を整える

Braze Docsに複雑な変更や複数ページの変更を加える前に、ローカル環境をセットアップする必要があります。しかし、小さな単一ドキュメントの変更は、GitHubで直接行うことができます。

ステップ 2.1:必要なソフトウェアを入手する

最低限、ターミナル、テキストエディタ、ルビー・バージョン・マネージャが必要だ。何から始めたらいいかわからない場合は、以下を参照。

タイプ 製品 説明
Git GUI GitHubデスクトップ ターミナルでコマンドを入力する代わりに、Gitコマンドを実行するためのグラフィカル・ユーザー・インターフェース（GUI）。
ターミナル ウェズターム コマンドラインからコマンドを実行し、Braze Docsリポジトリとやり取りできるターミナルエミュレータです。Windowsオペレーティング・システムを使用している場合は、Windows Subsystem for Linux（WSL）もインストールする必要があります。
ターミナル延長 Linux用Windowsサブシステム（WSL）*。 WSLを使えば、Linuxサブシステムをインストールし、Windowsオペレーティング・システム上でUnixライクなコマンドを実行できる。Windowsオペレーティング・システムから投稿する場合は、WSLをインストールすることをお勧めします。

* Windows版のみ。
パッケージマネージャー ホームブリュー Braze Docsへの投稿に使用するさまざまなコマンドラインインターフェイス（CLI）ツールをインストールして管理できるパッケージマネージャーです。
Rubyバージョンマネージャ ルベンブ ローカル環境のセットアップ時に、Braze Docsに必要なRubyのバージョンをインストール・管理できるRubyバージョンマネージャです。別のRubyバージョン・マネージャーを使う場合は、Rubyのサポートされているバージョン・マネージャーを参照してください。
テキストエディタ ビジュアルスタジオコード（VSコード） BrazeのDocsリポジトリにあるすべてのファイルを編集できる、Microsoftによるフル機能のテキストエディタです。より快適にご利用いただくために、以下のプラグインをインストールしてください：
テキストエディタ IntellijのIDEAコミュニティ・エディション Intellijによるフル機能のテキストエディタで、Braze Docsリポジトリのあらゆるファイルを編集できます。より快適にご利用いただくために、以下のプラグインをインストールしてください：

ステップ 2.2:GitHubアカウントを設定する

次に、GitHubアカウントを作成し、SSHキーを設定します。

ステップ 2.3:リポジトリをフォークする

Braze Docs GitHubリポジトリを開き、Forkを選択します。

The Braze Docs GitHub repository showing "Fork".

デフォルトの設定のまま、フォークの作成を選択します。

The Braze Docs GitHub repository showing "Create fork".

フォークしたリポジトリで、Code>SSH> Copy を選択します。

An example forked repository with the "Code" dropdown open showing the "Copy" option.

ターミナルでホームディレクトリを開き、Braze Docsリポジトリをクローンします。

1
2

cd ~
git clone [email protected]:braze-inc/braze-docs.git

ステップ 2.4:Rubyのインストール

ローカル・サイトのプレビューを生成するには、Rubyのバージョン3.2.2 。ターミナルでbraze-docs を開き、Rubyのバージョン3.2.2 をチェックする。

1
2

cd ~/braze-docs
ruby --version

このバージョンがインストールされていない場合は、サポートされているバージョン・マネージャーを使ってRubyのバージョン3.2.2 をインストールしてください。例えば、rbenv.

1

rbenv install 3.2.2

ステップ 2.5:依存関係をインストールする

次に、Braze Docsの依存関係をインストールします。これらは、ローカルのBraze Docsサイトを生成するための小さなプログラムです。

1

bundle install

次のステップ

Gitやdocs-as-codeが初めての方は、チュートリアルから始めましょう：あなたの最初の貢献そうでなければ、以下のいずれかをチェックしてほしい。

Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!