I am looking for a tool to spell-check English markdown documents in a pipeline.
Having seen and heard about the Hunspell project, I am not sure if that is the right tool to use - however looking online I might not use the right search terms or my approach is wrong as I do not find many results at all.
Anyone who has any advice of the direction to go?
Many thanks in beforehand.
Answering myself: this is a task for which the codespell CLI tool can be used.
Related
I noticed that comments and suggestions are not by default copied when using drive.files.copy. This is imperative to my project, so I did some googling and it seems like this feature may not even exist? I thought about copying and applying the comments manually using the Docs API, but I can't seem to find anything helpful about this on SO or the Google API documentation for Drive and Docs. Does anyone know if this is possible and how to do this?
Thanks
edit: the comments.list method returns comments, but not suggestions. I think I would be able to insert these comments manually into the copied document. What about suggestions? Is there a way to retrieve these?
It would be really nice if I could easily copy both without a lot of leg work.
Unfortunately it's not possible to copy a Google Docs file with comments and suggestions
As for comments, you can copy-paste them manually like done here.
However, suggestions are different from comments (at least as the Google APIs go) - see here for information.
In order to retrieve suggestions, you can use the documents.get method
Yet, inserting suggestions programmatically is currently not possible - see here for more details
I am looking for a better bamboo wallboard.
The wallboard provided by bamboo itself is not sufficient as it does only permit four colums and we have a ton of builds to monitor. The font is also too small to read from a distance.
Are there any good tools to create a nice wallboard for CI/Bamboo that work?
Thanks in advance.
Regards
Look at Atlasboard project we use for our dashboards. It has tons of customizable components to present info from Atlassian products: https://www.atlassian.com/blog/archives/guest-blog-using-atlasboard-create-testing-boards
I ended up using Greasmonkey and tinkering with the CSS.
I want to see how sphinx actually works,has anyone tried this?
If you are talking about "Sphinx - the free open-source SQL full-text search engine", then the answer is pretty simple: Go ahead and have a look at the source code :)
My Source Safe file comparer (diff) doesn't say where in the line there are differences. Which tool would I use for that?
And before someone tries to move it to SU, please note that we developers rely on these diff tools more than anyone else.
I like SourceGear's free diffmerge. They built it to work with their source control systems, so it's pretty feature-rich.
WinMerge does inline comparison. I don't know about "best", but it is free.
BeyondCompare is excellent, though not free. There is a screenshot of the within-line difference view on their website.
The one included with TortoiseSVN does a decent job.
BeyondCompare is also an excellent choice.
I love using ExamDiff Pro.
Araxis Merge is a good one.
Iam using NotePad++ Compare plugin, there is ultracompare as well.
Tool to Compare Two Files
Google Search for "compare files"
Best Diff Tool?
And the most complete list on wikipedia
BeyondCompare. Specially like their folder comparision option.
I like P4Merge...
http://www.perforce.com/perforce/products/merge.html
Is there an easy way to produce MSDN-style documentation from the Visual Studio XML output?
I'm not patient enough to set up a good xslt for it because I know I'm not the first person to cross this bridge.
Also, I tried setting up sandcastle recently, but it really made my eyes cross. Either I was missing something important in the process or it is just way too involved.
I know somebody out there has a really nice dead-simple solution.
I'm reiterating here because I think my formatting made that paragraph non-inviting to read:
I gave sandcastle a try but had a really hard time getting it set up.
What I really have in mind is something much simpler.
That is, unless I just don't understand the sandcastle process. It seemed like an awful lot of extra baggage to me just to produce something nice for the testers to work with.
You're looking for Sandcastle
Project Page: Sandcastle Releases
Blog: Sandcastle Blog
NDoc Code Documentation Generator for .NET used to be the tool of choice, but support has all but stopped.
Have a look at Sandcastle, which does exactly that. It's also one of the more simpler solutions out there, and it's more or less the tool of choice, so in the long run, maybe we could help you to set up Sandcastle if you specify what issues you encountered during setup?
You should also use the Sandcastle Help File Builder. It provides you with a ndoc like GUI for generating help files so you don't have to do anything from a command prompt.
Welcome to the Sandcastle Help File Builder Project
I've just set up Sandcastle again. Try installing it (the May 2008 release) and search for SandcastleGui.exe or something similar (it's in the examples folder or so).
Click Add Assembly and add your Assembly or Assemblies, add any .xml Documentation files (the ones generated by the compiler if you enabled that option) and then Build.
It will take some time, but the result will be worth the effort. It will actually look up stuff from MSDN, so your resulting documentation will also have the Class Inheritance all the way down to System.Object with links to MSDN and stuff.
Sandcastle seems a bit complicated at first, especially when you want to use it in an automated build, but I am absolutely sure it will be worth the effort.
Also have a look at Sandcastle Help File Builder, this is a somewhat more advanced GUI for it.
Follow this simple 5 step article and you are pretty much done. As a bonus you can use H2Viewer to view Html Help 2.x files.
I use NDoc3