Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add addin to website to allow for automatic documentation #1

Closed
gep13 opened this issue Nov 12, 2016 · 7 comments
Closed

Add addin to website to allow for automatic documentation #1

gep13 opened this issue Nov 12, 2016 · 7 comments

Comments

@gep13
Copy link
Contributor

gep13 commented Nov 12, 2016

This is just a suggestion, but think it would be a really good idea, to help with visibility of this addin.

i.e. get your addin listed here:

http://cakebuild.net/addins

Have a look at this PR:

cake-build/website#152

This assumes that you have added XML Documentation to your addin, as described here:

http://cakebuild.net/docs/contributing/documentation

Let me know if you have any questions. Thanks!

@Julien-Molina
Copy link
Contributor

Hi,

Thanks a lot for this suggestion, we are currently working on the first version of this addin and it's not finished yet. We will provide the documentation as soon as possible.

Regards,
Julien

@gep13
Copy link
Contributor Author

gep13 commented Nov 12, 2016

@Julien-Molina that is great news. Thanks for getting back to me.

@gep13
Copy link
Contributor Author

gep13 commented Jan 11, 2017

@Julien-Molina just wanted to touch base on this again. Is this addin now at a point for adding to the site? Thanks!

@Julien-Molina
Copy link
Contributor

Julien-Molina commented Jan 13, 2017

@gep13 The current version of this adding is the first "sable" version so I think you can add it to the site. In the future I will add new methods in this adding should I tell you to update the site or is it automatic ?

@gep13
Copy link
Contributor Author

gep13 commented Mar 9, 2017

@Julien-Molina once you have done the initial PR into the website, each time the website is built it will pull the latest version of the nuget package and include any new documentation. The website is built reasonably frequently, but if you ship a new version, feel free to prod us and we can push out a new version.

@Julien-Molina
Copy link
Contributor

@gep13 Here is the initial PR : cake-build/website#317 :)

@gep13
Copy link
Contributor Author

gep13 commented Mar 22, 2017

@Julien-Molina Thank you!

@gep13 gep13 closed this as completed Mar 22, 2017
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants