-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Open
Labels
AcceptedAccepted issue on our roadmapAccepted issue on our roadmapGood First IssueGood for new contributorsGood for new contributorsNeeded: documentationDocumentation is requiredDocumentation is required
Milestone
Description
Doc should be a more prominent doc than our FAQ and should include things like:
- When a build fails due to time out or memory constraints, what can I do? The common solution here is to reduce usage
- You can mock out dependencies instead of installing and using the dependencies (we have a FAQ entry that is mostly hidden and needs to be expanded).
- The next might be avoiding installation and imports altogether and using sphinx-autoapi to document your code.
- Lastly, open a support issue to get more resources.
- On a general failure, we should document that this is an error on our side and we need to either surface a user-facing error message or we need to fix a problem with our servers. Users should
file an issue on our issue trackersend us an email with the build id (see Move community support to email #5651) - Configuration file errors. For most of the errors, I think we can link to our docs on the actual schema. These will define in good detail how to use the config file. There are probably a few errors that could be called out though.
RichardLitt and ZRunner
Metadata
Metadata
Assignees
Labels
AcceptedAccepted issue on our roadmapAccepted issue on our roadmapGood First IssueGood for new contributorsGood for new contributorsNeeded: documentationDocumentation is requiredDocumentation is required