Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add public Git error messages #1283

Merged
merged 20 commits into from
Feb 6, 2024
Merged

docs: add public Git error messages #1283

merged 20 commits into from
Feb 6, 2024

Conversation

angeloashmore
Copy link
Member

@angeloashmore angeloashmore commented Feb 1, 2024

Context

DT-1941

The Solution

Add Markdown files for each Git-specific error. We will link to the public GitHub pages to allow users to learn more about an error.

We can use the prismic.dev/msg domain to alias links:

In the future, we may move these error messages to a prismic.io-hosted page.

Impact / Dependencies

The GitHub integration must link to the correct page. See https://github.com/prismicio/sm-api/pull/7.

Checklist before requesting a review

  • I hereby declare my code ready for review.
  • If it is a critical feature, I have added tests.
  • The CI is successful.
  • If there could backward compatibility issues, it has been discussed and planned.

Copy link

vercel bot commented Feb 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
slice-machine ✅ Ready (Inspect) Visit Preview Feb 5, 2024 11:48pm

Copy link

linear bot commented Feb 1, 2024

Base automatically changed from aa/dt-1891 to main February 2, 2024 00:16
Copy link
Collaborator

@bapmrl bapmrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!

messages/git-error.md Outdated Show resolved Hide resolved
messages/git-error.md Outdated Show resolved Hide resolved
messages/git-invalid-slice-machine-config.md Outdated Show resolved Hide resolved
messages/git-unauthorized-github.md Outdated Show resolved Hide resolved
messages/git-unauthorized-prismic.md Outdated Show resolved Hide resolved
messages/git-unauthorized-prismic.md Outdated Show resolved Hide resolved
messages/git-unsupported-adapter.md Outdated Show resolved Hide resolved
@angeloashmore angeloashmore merged commit 0b74c94 into main Feb 6, 2024
33 of 34 checks passed
@angeloashmore angeloashmore deleted the aa/dt-1891-errors branch February 6, 2024 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants