Docgen: use stardoc to generate all container rules docs #1890
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gravypod
approved these changes
Jun 12, 2021
alexeagle
force-pushed
the
docs2
branch
3 times, most recently
from
f8e2080 to
b5d6ed4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously only the container_image rule was generated by stardoc. We don't want one page per rule, so now we document the
container.bzlpublic api re-export level as one starlark module.Now our documentation stays in sync with the code like it should.
container_flattenis now documented, it was previously missing.Also makes the README a more usable length.
I compared the new page
https://github.com/alexeagle/rules_docker/blob/b24507f/docs/container.md
with the current README
https://github.com/bazelbuild/rules_docker#container_pull and below
I combed through that diff and copied back the manual edits that had been made since they were originally generated with stardoc.
Added redirects to the main README so that any users with bookmarks have those permalinks continue to work.