Skip to content

Improve the Build Process Documentation #4679

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

Closed
davidfischer opened this issue Sep 28, 2018 · 3 comments
Closed

Improve the Build Process Documentation #4679

davidfischer opened this issue Sep 28, 2018 · 3 comments
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required
Milestone

Comments

@davidfischer
Copy link
Contributor

While working on #4676, I linked from the getting started guides and import guides to the Build Process docs. These docs could use improvement and simplifications

Here's some ideas:

  • Detail common errors (out of memory, too much time) and what to do about it. We discuss these issues but we should use the exact verbiage in the error messages in the build output so people can search for them.
  • Do we really need a "Writing your own builder" section here? Maybe that should be in the developer docs. Ditto for "Builder responsibility".
  • Have details on configuring the right version of Python, right version of MkDocs/Sphinx, and other Yaml config options.
  • Do we really need links to tasks.py and doc_builders at the top? These should probably be much further down if anywhere.
  • The "You can see the current Docker build images..." paragraph is out of place. It should probably be under "The build environment".
@davidfischer davidfischer added this to the Documentation milestone Sep 28, 2018
@stsewd stsewd added the Needed: documentation Documentation is required label Sep 29, 2018
@stale
Copy link

stale bot commented Jan 10, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Jan 10, 2019
@humitos
Copy link
Member

humitos commented Jan 10, 2019

This issue is still valid and seems to have good ideas to re-work on the docs.

@stale stale bot removed the Status: stale Issue will be considered inactive soon label Jan 10, 2019
@humitos humitos added Accepted Accepted issue on our roadmap Status: stale Issue will be considered inactive soon labels Jan 10, 2019
@stale stale bot removed the Status: stale Issue will be considered inactive soon label Jan 10, 2019
@humitos
Copy link
Member

humitos commented Nov 9, 2022

Most of this page was re-written from when this issue was opened. We have troubleshooting sections in other places and examples about how to use the config file, build.jobs and more. I'm closing it.

@humitos humitos closed this as completed Nov 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants