marketing-cloud-docs

marketing_cloud_docs Repo

This repository contains the source files for generating the Marketing Cloud documentation published on developer.salesforce.com/docs.

For help with using the SFDocs framework, see SFDocs Help.

---

Contacts

Admins:

• M&J: Marty Gipson ([e-mail])
• Einstein: Belinda Hobbs ([e-mail])
• Content and Communications Experience (CCX) Engineering Team in Hyderabad ([e-mail])

Folder/File structure

See Understand the Repo Structure in SFDocs Help. `

Build the Docs Locally

1. Clone this repo.

2. Install volta, node, and yarn.

   curl https://get.volta.sh | bash
   

   volta install node
   

   volta install yarn
   

3. Set up the project.

   yarn setup
   

4. Validate files.

   yarn validate
   

   This command:

   • checks for broken links (missing images and missing external links)
   • runs linting
   • verifies content-config.yaml

5. Preview the project in a localhost.

   yarn start
   

   To reload the preview as you edit files, run the command with the --live flag.

   yarn start --live
   

   Browse to http://localhost:3000.

Remote Builds and Preview Apps

When you send a pull request to any of the protected branches(for example, main), if the build is successful, Heroku creates a preview environment and posts a link on the GitHub PR.