Skip to content

README.md

Latest commit

 

History

History
83 lines (54 loc) · 3.73 KB

README.md

File metadata and controls

83 lines (54 loc) · 3.73 KB

prismic-dev-msg

Github Actions CI Conventional Commits License

An extended message delivery facilitator for Prismic packages. It makes providing extended error and warning messages in packages an easy-to-follow and standard process.

How it works

It builds a Netlify _redirects file to handle redirects like the following:

https://prismic.dev/msg/client/vX.X.X/missing-fetch
 → https://github.com/prismicio/prismic-client/blob/vX.X.X/messages/missing-fetch.md

https://prismic.dev/msg/client/vX.X.X
 → https://github.com/prismicio/prismic-client/blob/vX.X.X/messages

With these redirects in place, linking to Markdown files in error and warning messages becomes a simple process.

The built site can be deployed directly to Netlify.

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

Asking a question: Open a new topic on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

Submitting code changes: For small fixes, feel free to open a pull request with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

For more clarity on this project and its structure you can also check out the detailed CONTRIBUTING.md document.

License

   Copyright 2013-2022 Prismic <contact@prismic.io> (https://prismic.io)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.