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

Re-org and rewrite of distribution, installation, and build docs #13539

Closed
15 of 18 tasks
jwnimmer-tri opened this issue Jun 11, 2020 · 3 comments
Closed
15 of 18 tasks

Re-org and rewrite of distribution, installation, and build docs #13539

jwnimmer-tri opened this issue Jun 11, 2020 · 3 comments
Assignees
Labels
component: distribution Nightly binaries, monthly releases, docker, installation Epic priority: low type: documentation

Comments

@jwnimmer-tri
Copy link
Collaborator

jwnimmer-tri commented Jun 11, 2020

There are numerous known issue and usability hurdles with Drake's documentation for how users consume Drake releases, nightlies, source builds, pydrake, etc.

It will be most efficient to take a big swing at all of these at once in a single editing pass, because some of the problems relate to how the information is organized, rather than the specific facts being presented.

I will link all of the relevant issues here:

Items marked as [citation] should be cited from the new documentation to encourage further discussion or provide context, but the issue will not be resolved by documentation changes.

@jwnimmer-tri

This comment has been minimized.

@jamiesnape
Copy link
Contributor

jamiesnape commented Sep 8, 2020

I would add the following (feel free to merge up top):

@jwnimmer-tri
Copy link
Collaborator Author

This is essentially done now. I've filed #22530 to kick off a last look, but most/all of the acute problems noted above have been resolved, at least in part.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: distribution Nightly binaries, monthly releases, docker, installation Epic priority: low type: documentation
Projects
None yet
Development

No branches or pull requests

2 participants