Skip to content

AdobeDocs/commerce-on-cloud.ja-JP

Repository files navigation

source-git-commit workflow-type source-wordcount ht-degree
b151aac666510594751937e80dc3d9db4ede41b7
tm+mt
815
1%

クラウドインフラストラクチャー上のAdobe Commerce

このサイトには、クラウドインフラストラクチャー上のCommerceに関する最新の開発者向けドキュメントが含まれています。

Adobe オープン Source行動規範

このプロジェクトでは、Adobe オープン Source行動規範 ​ を採用しています。 詳しくは、投稿の記事を参照してください。

Adobe コンテンツへの投稿について

Adobe ドキュメント投稿者ガイドを参照してください ​

投稿方法は、投稿者と、投稿したい変更の種類に応じて異なります。

軽微な変更

軽微な変更をコントリビューションする場合は、記事にアクセスして記事の下部に表示されるフィードバックエリアをクリックし、詳細なフィードバックオプション をクリックします。次に、編集の提案 をクリックして、GitHub の Markdown ソースファイルに移動します。 GitHub UI を使用して更新を行います。

このリポジトリのドキュメントおよびコード例について投稿者が送信した軽微な修正や説明は、Adobeの利用規約の対象となります。

コミュニティメンバーによる大幅な変更または新しい記事

Adobe コミュニティのメンバーが新しい記事を作成したり、大きな変更をコントリビューションしたりする場合は、Git リポジトリーの「イシュー」タブを使用してイシューを送信し、ドキュメントチームとのやり取りを開始してください。 計画に同意したら、公開および非公開リポジトリでの作業を組み合わせて新しいコンテンツを取り込むために、従業員と協力する必要があります。

Adobe社員からの大きな変化

Adobe Experience Cloud ソリューションの製品チームのテクニカルライター、プログラムマネージャー、または開発者で技術記事の投稿または作成を担当している場合は、https://git.corp.adobe.com/AdobeDocs のプライベートリポジトリを使用する必要があります。

ツールと設定

コミュニティのコントリビューターは、基本的な編集を行う場合は GitHub UI を使用し、大きな変更を加える場合はリポジトリをフォークします。

詳しくは、Adobe ドキュメント投稿者ガイド ​ を参照してください。

Markdown を使用してトピックを書式設定する方法

このリポジトリ内の記事はすべて、GitHub Flavored Markdown を使用しています。 Markdown について詳しくは、以下を参照してください。

テンプレート

一部のトピックでは、データファイルとテンプレートを使用して、公開済みコンテンツを生成します。 このアプローチのユースケースを次に示します。

  • プログラムで生成された大きなコンテンツセットの公開
  • 統合のために、YAML などの機械読み取り可能なファイル形式を必要とする複数のシステム(クラウド CLI ツール、サービス設定など)をまたいで、顧客に単一の情報源を提供する

テンプレート化されたコンテンツの例としては、次のようなものがあります(ただし、これに限定されません)。

テンプレートコンテンツの生成

通常、ほとんどのライターは、製品可用性テーブルとシステム要件テーブルにリリースバージョンを追加するだけで済みます。 その他のテンプレート化されたコンテンツのメンテナンスは、すべて専任のチームメンバーが自動化または管理します。 これらの説明は、ほとんどのライターを対象としています。

メモ:

  • テンプレート化されたコンテンツを生成するには、ターミナルのコマンドラインで作業する必要があります。
  • レンダリングスクリプトを実行するには、Ruby がインストールされている必要があります。 必要なバージョンについては [_jekyll/.ruby-version] (_jekyll/.ruby-version) を参照してください。

テンプレート化されたコンテンツのファイル構造について詳しくは、次を参照してください。

  • _jekyll - テンプレート化されたトピックと必要なアセットが含まれます
  • _jekyll/_data - テンプレートのレンダリングに使用される機械読み取り可能なファイル形式が含まれます
  • _jekyll/templated – 液体テンプレート言語を使用するHTMLベースのテンプレートファイルが含まれます
  • help/_includes/templated - テンプレート化されたコンテンツの生成された出力をファイル形式で含 .md、Experience League トピックで公開できるようにします。レンダリング・スクリプトは、生成された出力をこのディレクトリに自動的に書き込みます

テンプレート化されたコンテンツを更新するには:

  1. テキストエディターで、_jekyll/_data ディレクトリにあるデータファイルを開きます。 例:

  2. 既存の YAML 構造を使用してエントリを作成します。

  3. _jekyll ディレクトリに移動します。

    cd _jekyll
  4. テンプレート化されたコンテンツを生成し、出力を help/_includes/templated ディレクトリに書き込みます。

    bundle exec rake render

    注意: スクリプトは _jekyll ディレクトリから実行する必要があります。 スクリプトを初めて実行する場合は、bundle install コマンドを使用して Ruby の依存関係をインストールする必要があります。 Rake タスクは、Adobe Commerce ドキュメントリポジトリ全体のメンテナンス性を向上させるために、adobe-comdox-exl-rake-tasks gem によって提供されます。

  5. root ディレクトリに戻ります。

    cd ..
  6. 期待される help/_includes/templated ファイルが変更されたことを確認します。

    git status

    次のような出力が表示されます。

    modified:   _data/cloud-cli-ref.yaml
    modified:   help/_includes/templated/cloud-cli-ref.md
  7. 変更をプッシュします。

    git add .
    git commit -m "descriptive message of the intended commit"
    git push

​ データファイル ​​ 液体フィルター ​ およびその他の機能について詳しくは、Jekyll のドキュメントを参照してください。

使用可能な Rake タスク

このリポジトリは、adobe-comdox-exl-rake-tasks gem が提供する rake タスクを使用します。 使用可能なすべてのタスクを表示するには、次を実行します。

cd _jekyll
bundle exec rake --tasks

画像の最適化のプリコミットフック

このリポジトリには、コミット前に画像を最適化する、自動プリコミットフックが含まれています。 すべてのコントリビューターは、これらのフックを有効にして 一貫性のある画像の最適化とリポジトリサイズの縮小を実現する必要があります。

クイックセットアップ

リポジトリのクローンを作成したら、次のコマンドを実行します。

.githooks/setup-hooks.sh

フックの機能

  • ステージングされた画像ファイル(PNG、JPG、JPEG、GIF、SVG)を自動検出
  • image_optim を実行して画像を圧縮および最適化する
  • 最適化された画像を自動的に再ステージ
  • コミットされたイメージがすべて適切に最適化されていることを確認します。

利点

  • リポジトリサイズの縮小
  • ドキュメントのページ読み込みの高速化
  • すべてのコントリビューターで一貫した画質
  • 手動での最適化は不要です

設定手順、トラブルシューティング、設定について詳しくは、.githooks/README.md を参照してください。

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published