search

nunit / docs

Documentation for all active NUnit projects
https://docs.nunit.org
MIT License
602 stars 155 forks source link

Can we reference code link? #263

Open garora opened 6 years ago

garora commented 6 years ago

I was working TDD Katas and found few issues. During my R&D for the issue, I observed that something is missing on Wiki Docs. I will be updating docs, before that I would like to ask - can we add external repository code to make documentation more clear and hands-on?

rprouse commented 6 years ago

I noticed that your Katas are using NUnit 2.6.4. Is there a reason you are starting a project with 2.6.4 so long after 3.x was released? These documents are also for 3.x, the NUnit 2 documentation is not being updated.

I would be reluctant to accept links to code that we do not control. Can you explain more what you have in mind?

ChrisMaddock commented 6 years ago

I agree with everything @rprouse said - my only addition would be that contributions to our samples repo are very welcome, and could be linked from the docs.

Definitely worth posting an issue detailing what you're thinking of here before writing any code however - we're keen to keep the samples streamlined and focused.

garora commented 6 years ago

@rprouse - Thanks for spending time by reviewing TDD Katas repository. There are two flavors one is full framework and another is .NET Core. Yes, one is using version 2.6.4 of NUnit (we want to have it for legacy things) while other is purely for current release.

I would be reluctant to accept links to code that we do not control. Can you explain more what you have in mind?

I don't want to link any code that is beyond your reach. Also, I never said to write any code in the docs. I wanted to add a section of few practical problems that mostly developers face. Yes, I do agree that there are so many issues reported on the NUnit repo, I suggested to document the most common issue. For an instance, we faced issue that is a common problem. This is fine, if you don't like the idea. I just wanted to help community by updating documentations.

@ChrisMaddock - I would be happy to write any sample code in the mentioned repository. Your samples are good enough. But, can we have some link or some section where you can recommend the external repository for learning purposes. For example: TDD Katas is purely based on Unit testing learning.

P.S.: I'm just trying to help the community.

rprouse commented 6 years ago

@garora your help is appreciated and a FAQ section in the docs would be helpful. I find the current structure of the docs a bit lacking in that you need to know what you are looking for before you can find it. It would be good to have guidance on common problems and links to how to solve them rather than scanning attributes for something that might serve your needs.

We might consider a link to your TDD Katas, but I would like one of us to try them first. I would prefer that the list contains more than your katas though. 😉

I think what you are doing is great. I've used katas to help me explore many languages. I'd be happy to help you get the word out by tweeting about them, but a list of learning links in our docs will have a higher bar and must include multiple sources.

immeraufdemhund commented 6 years ago

I could contribute a little write up on test case source that I posted on csharp corner if that would help too.

edit: I need to update it to use NUnit 3 but I think the concept is still the same https://www.c-sharpcorner.com/UploadFile/0f29c1/nunit-test-case-source/

rprouse commented 6 years ago

@nunit/core-team what do you think about a page in the docs with links to quality blog posts and articles about NUnit and how to use it?

jnm2 commented 6 years ago

@rprouse Everything you've said sounds good!

immeraufdemhund commented 6 years ago

I love the idea

Sent from my Huawei Mobile

-------- Original Message -------- Subject: Re: [nunit/docs] Can we reference code link? (#263) From: Rob Prouse To: nunit/docs CC: Robert Snyder ,Comment

@nunit/core-teamhttps://github.com/orgs/nunit/teams/core-team what do you think about a page in the docs with links to quality blog posts and articles about NUnit and how to use it?

— You are receiving this because you commented. Reply to this email directly, view it on GitHubhttps://github.com/nunit/docs/issues/263#issuecomment-377084438, or mute the threadhttps://github.com/notifications/unsubscribe-auth/ADTj7UZcfTS59QeaWy4RlINLA8dPA1nuks5tjC5QgaJpZM4S9tCv.

garora commented 6 years ago

Great to know that community like the idea. You are free to try Kata repository - please note that I am managing the repository and we have contributors around the world. Appreciated!

ChrisMaddock commented 6 years ago

Is a page of external links the right way for people to discover the information?

docs.microsoft has a ‘See also’ section at the bottom of some pages, which sometimes links to relevant external sources. Would that help structure help categorise things a bit more? I don’t know where general katas would fit in in that sort of structure however...

garora commented 6 years ago

Yes, its another way to discover the information. Katas would fit everywhere as with the help of these one should practice Unit Testing and our whole NUnit repository is about Unit Testing framework.

On Thu, Mar 29, 2018 at 1:15 PM Chris Maddock notifications@github.com wrote:

Is a page of external links the right way for people to discover the information?

docs.microsoft has a ‘See also’ section at the bottom of some pages, which sometimes links to relevant external sources. Would that help structure help categorise things a bit more? I don’t know where general katas would fit in in that sort of structure however...

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/nunit/docs/issues/263#issuecomment-377151744, or mute the thread https://github.com/notifications/unsubscribe-auth/AA6_OQh1hqvss218zPrdfVGHzanH5EdKks5tjJEIgaJpZM4S9tCv .

-- Thanks & Regards, Gaurav Arora Lifetime member CSI http://www.csi-india.org/ | Microsoft MVP https://mvp.microsoft.com/en-us/PublicProfile/5001684 | IndiaMentor http://indiamentor.com/user/gaurav_arora/ http://indiamentor.com/user/gaurav_arora/| DotNetSpider http://www.dotnetspider.com/member/g_arora.aspx | Community Contributor http://https//social.technet.microsoft.com/profile/gaurav%20kumar%20arora/ | +91 9911966856 (M)

garora commented 5 years ago

Following back. Any progress on this?