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

Improve error diagnostics when checking embedding #23

Open
alexander-yevsyukov opened this issue Aug 6, 2020 · 0 comments
Open

Improve error diagnostics when checking embedding #23

alexander-yevsyukov opened this issue Aug 6, 2020 · 0 comments
Labels
bug Something isn't working

Comments

@alexander-yevsyukov
Copy link
Collaborator

Currently, the error message looks like this:

Failed to render ./docs/guides/integration.md:103: Fragment file `/home/runner/work/SpineEventEngine.github.io/SpineEventEngine.github.io/.fragments/examples/airport/airplane-supplies/src/main/proto/spine/example/airport/supplies/supplies_service.proto` not found. This may indicate that the file is not includedin `code_includes` or is not readable.

The file is included into the embed_code section of _config.yml using the **/*.proto syntax.
The file is also there and is readable when checked macOS when developing the site.

The subject of this issue is not fixing the issue, but improving the diagnostic when something wrong happens with accessing the file. Currently it says that the problem is either “this” or “that”. We need to tell exactly what's the problem so that the user can fix it quicker.

A minor issue is that the space is missing in “includedin” before “in”.

It is still puzzling for me why we need code_includes configuration when we reference the files explicitly when embedding them into markdown.

@alexander-yevsyukov alexander-yevsyukov added the bug Something isn't working label Aug 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant