Skip to content

Commit

Permalink
Add Troubleshooting docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jlantz committed Jan 9, 2024
1 parent 2ec9f2a commit 47b0200
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 10 deletions.
24 changes: 14 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ D2X is an open source collection of tools and configurations to quickly launch a

D2X is made up of:

* A Docker image with the latest versions of CumulusCI and SF CLI preinstalled
- A Docker image with the latest versions of CumulusCI and SF CLI preinstalled

* GitHub Package: https://github.com/muselab-d2x/d2x/pkgs/container/d2x
* Latest Docker Image: `ghcr.io/muselab-d2x/d2x:latest`
* A set of [reusable GitHub Actions workflows](https://github.com/muselab-d2x/d2x/tree/main/.github/workflows)
* A [devcontainer](https://containers.dev) [configuration](https://github.com/muselab-d2x/d2x/tree/main/.devcontainer) for use with GitHub Codespaces or any IDE with a Devcontainers extension
* A [project template](https://github.com/muselab-d2x/d2x-template) using [cookiecutter](https://cookiecutter.readthedocs.io)
- GitHub Package: https://github.com/muselab-d2x/d2x/pkgs/container/d2x
- Latest Docker Image: `ghcr.io/muselab-d2x/d2x:latest`

- A set of [reusable GitHub Actions workflows](https://github.com/muselab-d2x/d2x/tree/main/.github/workflows)
- A [devcontainer](https://containers.dev) [configuration](https://github.com/muselab-d2x/d2x/tree/main/.devcontainer) for use with GitHub Codespaces or any IDE with a Devcontainers extension
- A [project template](https://github.com/muselab-d2x/d2x-template) using [cookiecutter](https://cookiecutter.readthedocs.io)

D2X is a project of [MuseLab](https://muselab.com) and was created to support our [consulting services](https://muselab.com/services) with Salesforce partners and customers. We proudly share D2X as open source with the Salesforce community as part of our goal to revolutionize and democratize Salesforce DevOps.

Expand All @@ -25,10 +25,14 @@ You've created your own GitHub repository using [D2X Launchpad](https://launchpa

Head over to the [D2X Project Tutorial](tutorial.md) for next steps on finalizing your project's setup and getting started building.

## Troubleshooting

Need help troubleshooting an error? Check out the [Troubleshooting](troubleshooting.md) section for common error messages and tips on debugging issues.

## Resources

D2X itself doesn't require a lot of documentation. It's really about stitching together some amazingly powerful tools. Learning those tools is an important part of learning to work with D2X. The following documentation provides resouces to learn about those tools:

* [CumulusCI Documentation](https://cumulusci.readthedocs.io)
* [Trailhead: Build Applications with CumulusCI](https://trailhead.salesforce.com/content/learn/trails/build-applications-with-cumulusci)
* [Salesforce CLI](https://developer.salesforce.com/tools/salesforcecli)
- [CumulusCI Documentation](https://cumulusci.readthedocs.io)
- [Trailhead: Build Applications with CumulusCI](https://trailhead.salesforce.com/content/learn/trails/build-applications-with-cumulusci)
- [Salesforce CLI](https://developer.salesforce.com/tools/salesforcecli)
9 changes: 9 additions & 0 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Troubleshooting D2X

## Common Errors

### GitHub Actions

#### Error: The template is not valid. muselab-d2x/d2x/.github/workflows/feature-test-unlocked.yml@main (Line: 35, Col: 27): Unexpected value ''

This error can occur when you have a project that uses dependencies and you haven't set up the `CCI_GITHUB_TOKEN` secret for the repository in GitHub or haven't granted the repository permission to an organization level secret. Ensure that the CCI_GITHUB_TOKEN secret is available in the repository under Settings -> Secrets and variables -> Actions.

0 comments on commit 47b0200

Please sign in to comment.