Merge pull request #239 from AdobeDocs/4.9-rollout

rolling out aio-theme@4.9.7

.github/dependabot.yml

@@ -7,10 +7,12 @@ updates:
     # Check the npm registry for updates every day (weekdays)
     schedule:
       interval: "daily"
+    allow:
+      - dependency-name: "@adobe/gatsby-theme-aio"
     versioning-strategy: increase
     open-pull-requests-limit: 25
     labels:
       - "dependencies"
     ignore:
       # Ignore updates to package
-      - dependency-name: "*"
+      - dependency-name: "gatsby"

.github/super-linter.env

@@ -0,0 +1,6 @@
+IGNORE_GITIGNORED_FILES=true
+VALIDATE_GITLEAKS=true
+VALIDATE_MARKDOWN=true
+MARKDOWN_CONFIG_FILE=.markdownlint.yml
+VALIDATE_YAML=true
+VALIDATE_JSON=true

.github/workflows/ci.yml

@@ -17,6 +17,6 @@ jobs:
         with:
           node-version: 14
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
+        run: yarn install
       - name: Test Lint and Build
-        run: yarn build
+        run: yarn build

.github/workflows/deploy.yml

@@ -140,6 +140,7 @@ jobs:
           GATSBY_ALGOLIA_API_KEY: ${{ secrets.AIO_ALGOLIA_API_KEY }}
           GATSBY_ALGOLIA_INDEX_ALL_SRC: ${{ secrets.AIO_ALGOLIA_INDEX_ALL_SRC }}
           GATSBY_ALGOLIA_SEARCH_INDEX: ${{ secrets.AIO_ALGOLIA_SEARCH_INDEX }}
+          GATSBY_ALGOLIA_INDEX_ENV_PREFIX: ${{ secrets.AIO_ALGOLIA_INDEX_ENV_PREFIX }}
           GATSBY_FEDS_PRIVACY_ID: ${{ secrets.AIO_FEDS_PRIVACY_ID }}
 
       - name: Deploy
@@ -248,6 +249,7 @@ jobs:
           ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME || github.event.repository.name }}
           GATSBY_ALGOLIA_INDEX_ALL_SRC: ${{ secrets.AIO_ALGOLIA_INDEX_ALL_SRC }}
           GATSBY_ALGOLIA_SEARCH_INDEX: ${{ secrets.AIO_ALGOLIA_SEARCH_INDEX }}
+          GATSBY_ALGOLIA_INDEX_ENV_PREFIX: ${{ secrets.AIO_ALGOLIA_INDEX_ENV_PREFIX }}
           GATSBY_FEDS_PRIVACY_ID: ${{ secrets.AIO_FEDS_PRIVACY_ID }}
       - name: Deploy
         uses: icaraps/static-website-deploy@master

.github/workflows/github-pages.yml

@@ -10,7 +10,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Yarn Install
-        uses: bahmutov/npm-install@v1
+        uses: borales/actions-yarn@v4
+        with:
+          cmd: install # will run `yarn install` command
       - name: Build
         run: |
           yarn build

.github/workflows/test-pull-request.yml

@@ -40,6 +40,7 @@ jobs:
           # Full git history is needed to get a proper list of changed files
           # within `super-linter`
           fetch-depth: 0
+      - run: cat ".github/super-linter.env" >> "$GITHUB_ENV"
 
       ################################
       # Run Linters against code base #
@@ -49,21 +50,12 @@ jobs:
         # Use full version number to avoid cases when a next
         # released version is buggy
         # About slim image: https://github.com/github/super-linter#slim-image
-        uses: github/super-linter/slim@v4.9.4
+        uses: github/super-linter/slim@v4.10.1
         env:
-          VALIDATE_ALL_CODEBASE: false
-          DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DEFAULT_BRANCH: main
+          VALIDATE_ALL_CODEBASE: false
           VALIDATE_GITHUB_ACTIONS: true
-          VALIDATE_GITLEAKS: true
-          #
-          # The Markdown rules are defined at
-          # .github/linters/.markdown-lint.yml
-          #
-          # Documentation on rules:
-          # https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
-          VALIDATE_MARKDOWN: true
-          VALIDATE_YAML: true
 
       - name: Setup Node v16 for Yarn v3
         uses: actions/setup-node@v3
@@ -85,6 +77,11 @@ jobs:
         with:
           cmd: install
 
+      - name: Check internal links
+        uses: borales/actions-yarn@v3
+        with:
+          cmd: test:links
+
       - name: Build site
         if: ${{ success() }}
         uses: borales/actions-yarn@v3

package.json

@@ -12,7 +12,7 @@
     "url": "https://github.com/justinedelson"
   },
   "dependencies": {
-    "@adobe/gatsby-theme-aio": "^4.8.4",
+    "@adobe/gatsby-theme-aio": "^4.9.9",
     "@emotion/react": "11.8.2",
     "@spectrum-css/buttongroup": "3.0.10",
     "@spectrum-css/fieldlabel": "4.0.17",
@@ -52,7 +52,9 @@
     "eslint-plugin-react-hooks": "4.3.0",
     "jest": "27.5.1",
     "jest-junit": "13.0.0",
-    "js-yaml": "4.1.0"
+    "js-yaml": "4.1.0",
+    "remark-cli": "^11.0.0",
+    "remark-validate-links": "^12.1.0"
   },
   "scripts": {
     "start": "gatsby build && gatsby serve",
@@ -62,18 +64,24 @@
     "dev:https:stage": "gatsby develop --https --host developer-stage.adobe.com --port 443",
     "dev:https:prod": "gatsby develop --https --host www.adobe.io --port 443",
     "dev:debug": "node --nolazy node_modules/.bin/gatsby develop --inspect-brk",
-    "build": "yarn run lint && yarn run test && npx copyfiles -f swagger-specs/* static && gatsby build",
+    "build": "npx copyfiles -f swagger-specs/* static && gatsby build",
+    "build:test": "yarn run lint && yarn run test && npx copyfiles -f swagger-specs/* static && gatsby build",
     "build:incremental": "GATSBY_EXPERIMENTAL_PAGE_BUILD_ON_DATA_CHANGES=true gatsby build --log-pages",
     "serve": "gatsby serve",
     "clean": "gatsby clean",
-    "lint": "eslint gatsby-*.js src files scripts && node scripts/validate-permissions.js",
-    "lint-fix": "eslint gatsby-*.js src files scripts --fix",
+    "lint": "docker run --rm -e RUN_LOCAL=true --env-file '.github/super-linter.env' -v \"$PWD\":/tmp/lint github/super-linter:slim-v4.10.1",
     "postinstall": "patch-package",
     "test": "jest --config test/jest.config.js",
+    "test:links": "remark src/pages --quiet --frail",
     "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --config test/jest.config.js"
   },
   "engines": {
     "node": ">=14.0.0"
   },
+  "remarkConfig": {
+    "plugins": [
+      "remark-validate-links"
+    ]
+  },
   "packageManager": "yarn@3.2.2"
 }

src/pages/guides/api-usage/index.md

@@ -12,36 +12,36 @@ keywords:
 
 ### API Usage
 
-[Receiving Events](api-usage/receiving-events.md)
+[Receiving Events](/src/pages/guides/api-usage/receiving-events.md)
 
 Understand how events are structured.
 
 <DiscoverBlock slots="link, text"/>
 
-[Understanding Metric Data](api-usage/understanding-metric-data.md) 
-     
+[Understanding Metric Data](/src/pages/guides/api-usage/understanding-metric-data.md)
+
 See how metric data is structured.
 
 <DiscoverBlock slots="link, text"/>
 
-[Editing and Deleting Pipelines](api-usage/editing-and-deleting-pipelines.md) 
+[Editing and Deleting Pipelines](/src/pages/guides/api-usage/editing-and-deleting-pipelines.md)
 
 See how to edit and delete pipelines.
 
 <DiscoverBlock slots="link, text"/>
 
-[Advancing and Cancelling Steps](api-usage/advancing-and-cancelling-steps.md) 
+[Advancing and Cancelling Steps](/src/pages/guides/api-usage/advancing-and-cancelling-steps.md)
 
 See how to advance and cancel steps using the API.
 
 <DiscoverBlock slots="link, text"/>
 
-[Creating Programs and Environments](api-usage/creating-programs-and-environments.md) 
+[Creating Programs and Environments](/src/pages/guides/api-usage/creating-programs-and-environments.md)
 
 See how to create programs and environments.
 
 <DiscoverBlock slots="link, text"/>
 
-[Adding Custom Domain Names](api-usage/adding-custom-domain-names.md)
+[Adding Custom Domain Names](/src/pages/guides/api-usage/adding-custom-domain-names.md)
 
 Learn how to add your own custom domain names to an environment.

src/pages/guides/getting-started/index.md

@@ -12,36 +12,36 @@ keywords:
 
 ### Getting Started
 
-[Understanding the API](getting-started/understanding-the-api.md)
+[Understanding the API](/src/pages/guides/getting-started/understanding-the-api.md)
 
 Get an understanding of how the Cloud Manager API is structured.
 
 <DiscoverBlock slots="link, text"/>
 
-[Creating an API Integration](getting-started/create-api-integration/) 
-     
+[Creating an API Integration](/src/pages/guides/getting-started/create-api-integration.md)
+
 Learn how to create an API Integration Project.
 
 <DiscoverBlock slots="link, text"/>
 
-[Creating an Event Integration](getting-started/create-event-integration/) 
+[Creating an Event Integration](/src/pages/guides/getting-started/create-event-integration.md)
 
 Learn how to create an Event Integration Project to receive webhooks when your pipelines execute.
 
 <DiscoverBlock slots="link, text"/>
 
-[Getting Started with Postman](getting-started/getting-started-with-postman/) 
+[Getting Started with Postman](/src/pages/guides/getting-started/getting-started-with-postman.md)
 
 Learn how to expirement with the API using Postman.
 
 <DiscoverBlock slots="link, text"/>
 
-[Authentication](getting-started/authentication/)
+[Authentication](/src/pages/guides/getting-started/authentication.md)
 
 Learn how to authenticate API calls.
 
 <DiscoverBlock slots="link, text"/>
 
-[Permissions](getting-started/permissions/)
+[Permissions](/src/pages/guides/getting-started/permissions.md)
 
-See which permissions are required for using the API.
+See which permissions are required for using the API.

src/pages/guides/getting-started/understanding-the-api.md

@@ -33,7 +33,7 @@ The embedded resources themselves may contain links and _other_ embedded resourc
 
 ### Links
 
-Links in a resource are defined using a link type (commonly called a "rel", short for relationship). The special link type `self` is a link to the resource itself. 
+Links in a resource are defined using a link type (commonly called a "rel", short for relationship). The special link type `self` is a link to the resource itself.
 
 ```json
 "_links": {
@@ -82,7 +82,7 @@ Embedded resources are named, like links. In some cases, a resource may have a m
 
 ## Event Structure
 
-Events are represented as JSON objects which follow the [Activity Stream](https://www.w3.org/TR/activitystreams-core/) specification. Each event has a type, contained in the `@type` property, and an object, defined in the `activitystreams:object` property. More information can be found on the [Receiving Events](../api-usage/receiving-events/) page as well as the [Reference Documentation](../../reference/events/).
+Events are represented as JSON objects which follow the [Activity Stream](https://www.w3.org/TR/activitystreams-core/) specification. Each event has a type, contained in the `@type` property, and an object, defined in the `activitystreams:object` property. More information can be found on the [Receiving Events](../api-usage/receiving-events.md) page as well as the [Reference Documentation](../../reference/events.md).
 
 ### Example
 
@@ -104,4 +104,4 @@ Events are represented as JSON objects which follow the [Activity Stream](https:
     "xdmEventEnvelope:objectType" : "https://ns.adobe.com/experience/cloudmanager/pipeline-execution"
   }
 }
-```
+```

src/pages/index.md

@@ -8,7 +8,7 @@ keywords:
   - Cloud Manager
 ---
 
-<Hero slots="image, heading, text"/> 
+<Hero slots="image, heading, text"/>
 
 ![Hero image](img/pipeline-illustration.png)
 
@@ -29,27 +29,27 @@ Cloud Manager includes a full-featured web user interface at [https://my.cloudma
 
 General information on Cloud Manager can be found in the Product Documentation in the Resources section.
 
-The links in this documentation will guide you through getting started with the Cloud Manager API. There is also a complete [API Reference](reference/api/) which describes all of the individual endpoints and requests which are available for usage.
+The links in this documentation will guide you through getting started with the Cloud Manager API. There is also a complete [API Reference](reference/api.md) which describes all of the individual endpoints and requests which are available for usage.
 
-## Discover 
+## Discover
 
 <DiscoverBlock slots="heading, link, text"/>
 
 ### Guides
 
-[Creating an API Integration Project](guides/getting-started/create-api-integration/) 
-     
+[Creating an API Integration Project](guides/getting-started/create-api-integration.md)
+
 Learn how to create an API Integration Project
 
 <DiscoverBlock slots="link, text"/>
 
-[Creating an Event Integration Project](guides/getting-started/create-event-integration/) 
+[Creating an Event Integration Project](guides/getting-started/create-event-integration.md)
 
 Learn how to create an Event Integration Project to receive webhooks when your pipelines execute.
 
 <DiscoverBlock slots="link, text"/>
 
-[Permissions](guides/getting-started/permissions/)
+[Permissions](guides/getting-started/permissions.md)
 
 See which permissions are required for using the API.
 
@@ -61,38 +61,38 @@ See which permissions are required for using the API.
 
 ### Detailed API Information
 
-[Complete API Reference](reference/api/) 
+[Complete API Reference](reference/api.md)
 
 See the full API Reference.
 
 <DiscoverBlock slots="link, text"/>
 
-[Event Definitions](reference/events/) 
+[Event Definitions](reference/events.md)
 
 See the definitions of events sent from Cloud Manager.
 
 <DiscoverBlock slots="link, text"/>
 
-[API Playground](reference/playground/) 
+[API Playground](reference/playground.md)
 
 Make API calls from your browser.
 
 <DiscoverBlock width="100%" slots="heading, link, text"/>
 
 ### Tutorial
 
-[Tutorial](tutorial/) 
+[Tutorial](tutorial/)
 
 Walk through a step-by-step tutorial
 
 <DiscoverBlock width="100%" slots="heading, link, text"/>
 
 ### CLI and SDKs
 
-[CLI and SDKs](cli-and-sdks/) 
+[CLI and SDKs](cli-and-sdks/)
 
 Learn about the Cloud Manager CLI and the available SDKs for easy project integration.
 
-## Contributing 
+## Contributing
 
 We encourage you to participate in our open documentation initiative, if you have suggestions, corrections, additions or deletions for this documentation, check out the source from [this github repo](https://github.com/AdobeDocs/cloudmanager-api-docs), create issues, and submit pull requests with your contribution.

src/pages/reference/index.md

@@ -14,12 +14,12 @@ keywords:
 
 <DiscoverBlock slots="link, text"/>
 
-[Cloud Manager API](api/) 
-     
+[Cloud Manager API](./api.md)
+
 See how metric data is structured.
 
 <DiscoverBlock slots="link, text"/>
 
-[Event Definitions](events/) 
+[Event Definitions](./events.md)
 
-See how to edit and delete pipelines.
+See how to edit and delete pipelines.