Add documentation #7
Conversation
|
Once this is merged and a first (pre)-release is available on nuget.org documentation can be added to https://cakeissues.net with cake-contrib/Cake.Issues.Website#139 |
| Title: Requirements | ||
| Description: Requirements for the Cake.Issues.DupFinder addin. | ||
| --- | ||
| The requirements for using the [Cake.Issues.DupFinder addin] are listed in the [release notes] for any specific version. |
There was a problem hiding this comment.
Is this OK for you to mention the requirement in release notes?
There was a problem hiding this comment.
Not sure on what the requirement are except Cake.Issues and the JetBrains commandline tools.
There was a problem hiding this comment.
Addins are built against a specific API of Cake, in this case also a specific API of Cake.Issues and have requirements for target Framework. See e.g. the requirements section for Cake.Issues.InspectCode:
Requirements
- Cake 0.33.0 or higher
- Cake.Issues 0.8.x
- Targeting .NET Standard 2.0 and .NET Framework 4.6.1
pascalberger
force-pushed
the
feature/doc
branch
from
9662dad
to
237b692
Compare
|
@janniksam I updated the feature page based on your implementation. Please have another look if it is OK now |
|
Can you give me a short description on how these files will be used? Are they part of a specific tool or are they automatically taken and shown somewhere? Is there a process behind all this? |
|
cake-contrib/Cake.Issues.Website#139 will use them to integrate into https://cakeissues.net. See docs folder of Cake.Issues.InspectCode which is rendered on https://cakeissues.net/docs/issue-providers/inspectcode/. Rendering / integration is done in the build script of the Cake.Issues.Website repo. If you prefer to not have it added to https://cakeissues.net this would also be fine for me. |
That is totally fine with me. 👍 I am just a bit overwhelmed right now by all these new technologies. A lot of magic happening in the background. Hopefully I will get into that pretty quickly, the release process (versioning etc) is still a big question for me. But I'll contact you with my questions on gitter, if I have more. This is the wrong place ;-) |
|
Sure just hit me up on Twitter and we can walk together through versioning / release |
|
Can this be merged now? We could give some more details about the issue, for example that ProjectName and ProjectFileRelativePath are never filled. |
|
OK for me to merge it. It's currently in sync with the documentation of other issue providers which showning a red "x" for properties which are not filled (like here). |
Adds documentation for the addin for inclusion in https://cakeissues.net/.
Features need to be updated to match the actual implementation. Documentation in
requirements.mdassumes that requirements are listed in each release note entry on GitHub (which are imported into https://cakeissues.net/).@janniksam I'll it up to you to update the PR to matching your implementation