Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Deploy docs to GitHub Pages

on:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/pages.yaml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment, cancel in-progress runs of this workflow.
concurrency:
group: pages
cancel-in-progress: true

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload docs artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,32 @@
# Your Project's Title...
Your project's description...
# Holland America Line — AEM Edge Delivery Services

The Holland America Line website built on Adobe Experience Manager Edge Delivery Services (EDS). Content is authored in Document Authoring (DA); the codebase carries the Holland America brand system and a library of reusable blocks.

## 📖 Getting Started Guide

A developer & author guide — the initiative summary, where the code and content live, how to find the GitHub repo and DA folder, and how to run locally — is published via GitHub Pages:

**https://adobedevxsc.github.io/hal/**

Source: [`docs/index.html`](docs/index.html)

## Environments
- Preview: https://main--{repo}--{owner}.aem.page/
- Live: https://main--{repo}--{owner}.aem.live/

- Preview: https://main--hal--AdobeDevXSC.aem.page/
- Live: https://main--hal--AdobeDevXSC.aem.live/
- Content (DA): https://da.live/#/AdobeDevXSC/hal

## Documentation

Before using the aem-block-collection, we recommand you to go through the documentation on https://www.aem.live/docs/ and more specifically:
For background on AEM Edge Delivery Services, see https://www.aem.live/docs/ and specifically:
1. [Developer Tutorial](https://www.aem.live/developer/tutorial)
2. [The Anatomy of a Project](https://www.aem.live/developer/anatomy-of-a-project)
3. [Web Performance](https://www.aem.live/developer/keeping-it-100)
4. [Markup, Sections, Blocks, and Auto Blocking](https://www.aem.live/developer/markup-sections-blocks)
5. [AEM Block Collection](https://www.aem.live/developer/block-collection#block-collection-1)

Project-specific coding standards and the publishing workflow live in [AGENTS.md](AGENTS.md).

## Installation

```sh
Expand All @@ -28,8 +41,6 @@ npm run lint

## Local development

1. Create a new repository based on the `aem-block-collection` template and add a mountpoint in the `fstab.yaml`
1. Add the [AEM Code Sync GitHub App](https://github.com/apps/aem-code-sync) to the repository
1. Install the [AEM CLI](https://github.com/adobe/helix-cli): `npm install -g @adobe/aem-cli`
1. Start AEM Proxy: `aem up` (opens your browser at `http://localhost:3000`)
1. Open the `{repo}` directory in your favorite IDE and start coding :)
1. Open the project directory in your favorite IDE and start coding :)
Loading
Loading