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

(build) Disable documentation of build script tasks #692

Merged
merged 1 commit into from Aug 1, 2019

Conversation

@pascalberger
Copy link
Member

commented Jul 30, 2019

Disable generation of build script tasks documentation

@mwallner mwallner merged commit fcd3910 into chocolatey:develop Aug 1, 2019

3 checks passed

Codacy/PR Quality Review Up to standards. A positive pull request.
Details
CodeFactor No issues found.
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
@gep13

This comment has been minimized.

Copy link
Member

commented Aug 1, 2019

@pascalberger I am not too concerned either way, but was there a compelling reason for turning this off?

@pascalberger

This comment has been minimized.

Copy link
Member Author

commented Aug 1, 2019

@gep13 I think the question is what's the target audience of this documentation? End-users or developers?

End-users would not be interested in the build scripts available to building the application. Having a "Tasks" menu item that prominent, which also doesn't explain what kind of tasks it documents, is probably quite confusing for them.

For developers having a list of tasks provided by the underlying build script recipe is probably also not that much of an intereset as it doesn't show the actual build process used for this repo (e.g. some tasks are disabled by configuration but still shown here). If we want to have documentation about the build process for developers I would find it much more helpful to have a chapter somewhere mentioning that it uses Cake.Recipe with a link to the Cake.Recipe documentation where the individual tasks already are documented, and additional documentation about repo specific configuration and additional tasks. Or topic specific documentation, like done for the Localization Howto.

@pascalberger pascalberger deleted the pascalberger:feature/disable-task-doc branch Aug 1, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.