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

Add Cake Addin to Website #1

Closed
gep13 opened this issue Nov 29, 2017 · 10 comments
Closed

Add Cake Addin to Website #1

gep13 opened this issue Nov 29, 2017 · 10 comments

Comments

@gep13
Copy link

gep13 commented Nov 29, 2017

Great work on getting this addin created!

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#290

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!

@Kemyke
Copy link
Owner

Kemyke commented Nov 29, 2017

Hi @gep13

i uploaded the XML docs and tests for this project. Can you please check them and verify it.
If you found it ok, i will do the PR for the website.

Thanks!

@gep13
Copy link
Author

gep13 commented Nov 29, 2017

Your NuGet package doesn't seem to contain the XML Documentation file that would be needed to show the documentation on the website.

Have a look at the content of this package:

https://www.nuget.org/packages/Cake.Gitter/

For an example of what is expected.

@Kemyke
Copy link
Owner

Kemyke commented Nov 29, 2017

Oh wait, i haven't created new package yet. I've just added the comments in code.

@Kemyke
Copy link
Owner

Kemyke commented Nov 29, 2017

Now i uploaded the version 0.0.6. It is not yet indexed. Please check this version.

@gep13
Copy link
Author

gep13 commented Nov 29, 2017

That looks better 😄

If you make the change to the website, and build/run the website locally, you should be able to see if the XML comments are pulled through correctly onto the site.

@Kemyke
Copy link
Owner

Kemyke commented Nov 29, 2017

cake-build/website#443

@gep13
Copy link
Author

gep13 commented Nov 29, 2017

@Kemyke perfect, I will try to get that, and your other PR, merged tomorrow. Thanks for doing this! 😄

@Kemyke
Copy link
Owner

Kemyke commented Nov 29, 2017

No worries! I am happy to help the community. I hope these packages will be useful for others.

@gep13
Copy link
Author

gep13 commented Nov 29, 2017

I am sure that they will be 👍

@gep13
Copy link
Author

gep13 commented Dec 13, 2017

@Kemyke thank you for doing this!

@gep13 gep13 closed this as completed Dec 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants