diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 43d5ca5..8af21cc 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -14,7 +14,33 @@ accept all risks, known and unknown, associated with its usage, including with respect to your deployment of any portion of this solution in your systems, or usage in connection with your business, if at all._ -[TOC] +- [Shoptimizer API Developer Guide](#shoptimizer-api-developer-guide) + * [0. About](#0-about) + * [1. Prerequisites](#1-prerequisites) + * [2. Architecture Overview](#2-architecture-overview) + + [2.1 Shoptimizer Workflow](#21-shoptimizer-workflow) + + [2.2 API Specification](#22-api-specification) + + [2.3 Example Usage](#23-example-usage) + * [3. Config Files](#3-config-files) + * [4. Integrating Shoptimizer with your Content API Client](#4-integrating-shoptimizer-with-your-content-api-client) + + [4.1 Authentication](#41-authentication) + + [4.2 Calling Shoptimizer](#42-calling-shoptimizer) + + [4.3 Parsing the Response](#43-parsing-the-response) + + [4.4 Checking for Errors](#44-checking-for-errors) + - [4.4.1 Bad Requests](#441-bad-requests) + - [4.4.2 Optimizer Errors](#442-optimizer-errors) + + [4.5 Complete Code Sample](#45-complete-code-sample) + * [5. Activating Optimizers](#5-activating-optimizers) + * [6. Writing a Plugin](#6-writing-a-plugin) + + [6.1 Create a New Module](#61-create-a-new-module) + + [6.2 Implement from BaseOptimizer](#62-implement-from-baseoptimizer) + + [6.3 Install MeCab](#63-install-mecab) + + [6.4 Run Unit Tests](#64-run-unit-tests) + + [6.5 Update Shoptimizer](#65-update-shoptimizer) + * [7. Tracking Optimization Performance](#7-tracking-optimization-performance) + + [7.1 Log the Shoptimizer Response](#71-log-the-shoptimizer-response) + + [7.2 View customLabel Fields in Google Ads](#72-view-customlabel-fields-in-google-ads) + * [8. Run Unit Tests](#8-run-unit-tests) ## 0. About diff --git a/docs/install-guide.md b/docs/install-guide.md index af30123..1249767 100644 --- a/docs/install-guide.md +++ b/docs/install-guide.md @@ -14,7 +14,28 @@ accept all risks, known and unknown, associated with its usage, including with respect to your deployment of any portion of this solution in your systems, or usage in connection with your business, if at all._ -[TOC] +- [Shoptimizer API Install Guide](#shoptimizer-api-install-guide) + * [0. About](#0-about) + * [1. Prerequisites](#1-prerequisites) + * [2. Installing Shoptimizer](#2-installing-shoptimizer) + + [2.1 Installing to GCP Cloud Run automatically](#21-installing-to-gcp-cloud-run-automatically) + - [2.1.1 Clone the Solution and set environment variables](#211-clone-the-solution-and-set-environment-variables) + - [2.1.2 Run the command-line installation script](#212-run-the-command-line-installation-script) + - [2.1.3 Start the deployment using the installed GCP Cloud Build trigger](#213-start-the-deployment-using-the-installed-gcp-cloud-build-trigger) + + [2.2 Installing to GCP Cloud Run manually](#22-installing-to-gcp-cloud-run-manually) + - [2.2.1 Install Docker and set up the Cloud SDK.](#221-install-docker-and-set-up-the-cloud-sdk) + - [2.2.2 Build the Image](#222-build-the-image) + - [2.2.3 Push the Image to the GCR](#223-push-the-image-to-the-gcr) + - [2.2.4 Deploy to Cloud Run](#224-deploy-to-cloud-run) + + [2.3 Build and run Shoptimizer on Docker (local)](#23-build-and-run-shoptimizer-on-docker--local-) + - [2.3.1 Clone the Solution](#231-clone-the-solution) + - [2.3.2 Build the Image](#232-build-the-image) + - [2.3.3 Run the Container](#233-run-the-container) + * [3. Testing the Shoptimizer API](#3-testing-the-shoptimizer-api) + + [3.1 Local testing](#31-local-testing) + + [3.2 Testing on GCP Cloud Run](#32-testing-on-gcp-cloud-run) + * [4. Container Security](#4-container-security) + * [5. Updating Shoptimizer](#5-updating-shoptimizer) ## 0. About