Skip to content

Create docs/ folder - #1832

Merged
alexeagle merged 1 commit into
bazelbuild:masterfrom
alexeagle:docs
Apr 28, 2021
Merged

Create docs/ folder#1832
alexeagle merged 1 commit into
bazelbuild:masterfrom
alexeagle:docs

Conversation

@alexeagle

Copy link
Copy Markdown
Contributor

Move the existing starlark target there, and check in the generated output.
Uses generated_file_test since that prints the bazel run command to accept the new file,
making this workflow easy for novice contributors to follow.

Also don't make users install the stardoc repository anymore, now that they don't load() from this BUILD file they shouldn't need it.

@google-cla google-cla Bot added the cla: yes label Apr 27, 2021
@alexeagle
alexeagle force-pushed the docs branch 7 times, most recently from 97ef0df to 6c3cbb6 Compare April 27, 2021 05:32
@UebelAndre

Copy link
Copy Markdown
Contributor

It'd be great if the docs directory was a separate workspace which doubled as a visibility test.

@alexeagle
alexeagle marked this pull request as ready for review April 28, 2021 01:17
Comment thread README.md Outdated
</tr>
</tbody>
</table>
**MOVED**: See generated API documentation in docs/image.md

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make docs/image.md a link?

This documentation is now generated from sources rather than hand-maintained in markdown/HTML.

Move the existing starlark target there, and check in the generated output.
Uses generated_file_test since that prints the bazel run command to accept the new file,
making this workflow easy for novice contributors to follow.

Also don't make users install the stardoc repository anymore, now that they don't load() from this BUILD file they shouldn't need it.
@alexeagle
alexeagle merged commit a8bfc2d into bazelbuild:master Apr 28, 2021
martaver pushed a commit to cleric-sh/rules_docker that referenced this pull request May 18, 2021
…zelbuild#1832)

This documentation is now generated from sources rather than hand-maintained in markdown/HTML.

Move the existing starlark target there, and check in the generated output.
Uses generated_file_test since that prints the bazel run command to accept the new file,
making this workflow easy for novice contributors to follow.

Also don't make users install the stardoc repository anymore, now that they don't load() from this BUILD file they shouldn't need it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants