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.

Sign up for GitHub

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

Jump to bottom

Add example documentation to aliases #750

Closed
75 tasks done
patriksvensson opened this issue Mar 10, 2016 · 5 comments
Closed
75 tasks done

Add example documentation to aliases #750

patriksvensson opened this issue Mar 10, 2016 · 5 comments
Labels
Documentation
Milestone
v0.15.0

Comments

@patriksvensson
Copy link
Member

patriksvensson commented Mar 10, 2016 •
edited by gep13
Loading

This _do not_ have to be done in a single PR. Make sure to reference this issue if you submit example documentation and we'll cross it off the list once it's merged.

An example of how example documentation could look like can be found here: https://github.com/cake-build/cake/blob/develop/src/Cake.Common/IO/FileAliases.cs#L20-L29

Aliases without example documentation:

  • Cake.Common​.StartProcess(FilePath, ​ProcessSettings, ​out IEnumerable)​
  • Cake.Common.IO​.Unzip(FilePath, ​DirectoryPath)​
  • Cake.Common.Net​.DownloadFile(string)​
  • Cake.Common.Net​.DownloadFile(Uri)​
  • Cake.Common.Net​.DownloadFile(string, ​FilePath)​
  • Cake.Common.Net​.DownloadFile(Uri, ​FilePath)​
  • Cake.Common.Tools​.DotNetBuild(FilePath)​
  • Cake.Common.Tools​.DotNetBuild(FilePath, ​Action<DotNetBuildSettings>)​
  • Cake.Common.Tools.MSBuild​.MSBuild(FilePath)​
  • Cake.Common.Tools.MSBuild​.MSBuild(FilePath, ​Action<MSBuildSettings>)​
  • Cake.Common.Tools.MSBuild​.MSBuild(FilePath, ​MSBuildSettings)​
  • Cake.Common.Tools.MSTest​.MSTest(string)​
  • Cake.Common.Tools.MSTest​.MSTest(string, ​MSTestSettings)​
  • Cake.Common.Tools.MSTest​.MSTest(IEnumerable<FilePath>)​
  • Cake.Common.Tools.MSTest​.MSTest(IEnumerable<FilePath>, ​MSTestSettings)​
  • Cake.Common.Tools.NuGet​.NuGetSetApiKey(string, ​string, ​NuGetSetApiKeySettings)​
  • Cake.Common.Tools.NuGet​.NuGetSetApiKey(string, ​string)​
  • Cake.Common.Tools.NuGet​.NuGetSetProxy(string, ​string, ​string, ​NuGetSetProxySettings)​
  • Cake.Common.Tools.NuGet​.NuGetSetProxy(string, ​string, ​string)​
  • Cake.Common.Tools.NUnit​.NUnit3(string)​
  • Cake.Common.Tools.NUnit​.NUnit3(string, ​NUnit3Settings)​
  • Cake.Common.Tools.NUnit​.NUnit3(IEnumerable<string>)​
  • Cake.Common.Tools.NUnit​.NUnit3(IEnumerable<FilePath>)​
  • Cake.Common.Tools.NUnit​.NUnit3(IEnumerable<string>, ​NUnit3Settings)​
  • Cake.Common.Tools.NUnit​.NUnit3(IEnumerable<FilePath>, ​NUnit3Settings)​
  • Cake.Common.Tools.NUnit​.NUnit(string)​
  • Cake.Common.Tools.NUnit​.NUnit(string, ​NUnitSettings)​
  • Cake.Common.Tools.NUnit​.NUnit(IEnumerable<string>)​
  • Cake.Common.Tools.NUnit​.NUnit(IEnumerable<FilePath>)​
  • Cake.Common.Tools.NUnit​.NUnit(IEnumerable<string>, ​NUnitSettings)​
  • Cake.Common.Tools.NUnit​.NUnit(IEnumerable<FilePath>, ​NUnitSettings)​
  • Cake.Common.Tools.Roundhouse​.RoundhouseMigrate(RoundhouseSettings)​
  • Cake.Common.Tools.Roundhouse​.RoundhouseDrop(RoundhouseSettings)​
  • Cake.Common.Tools.WiX​.WiXCandle(string, ​CandleSettings)​
  • Cake.Common.Tools.WiX​.WiXCandle(IEnumerable<FilePath>, ​CandleSettings)​
  • Cake.Common.Tools.WiX​.WiXLight(string, ​LightSettings)​
  • Cake.Common.Tools.WiX​.WiXLight(IEnumerable<FilePath>, ​LightSettings)​
  • Cake.Common.Tools.XBuild​.XBuild(FilePath)​
  • Cake.Common.Tools.XBuild​.XBuild(FilePath, ​Action<XBuildSettings>)​
  • Cake.Common.Tools.XBuild​.XBuild(FilePath, ​XBuildSettings)​
  • Cake.Common.Tools.XUnit​.XUnit2(string)​
  • Cake.Common.Tools.XUnit​.XUnit2(string, ​XUnit2Settings)​
  • Cake.Common.Tools.XUnit​.XUnit2(IEnumerable<string>)​
  • Cake.Common.Tools.XUnit​.XUnit2(IEnumerable<FilePath>)​
  • Cake.Common.Tools.XUnit​.XUnit2(IEnumerable<string>, ​XUnit2Settings)​
  • Cake.Common.Tools.XUnit​.XUnit2(IEnumerable<FilePath>, ​XUnit2Settings)​
  • Cake.Common.Tools.XUnit​.XUnit(string)​
  • Cake.Common.Tools.XUnit​.XUnit(string, ​XUnitSettings)​
  • Cake.Common.Tools.XUnit​.XUnit(IEnumerable<string>)​
  • Cake.Common.Tools.XUnit​.XUnit(IEnumerable<FilePath>)​
  • Cake.Common.Tools.XUnit​.XUnit(IEnumerable<string>, ​XUnitSettings)​
  • Cake.Common.Tools.DupFinder​.DupFinder(FilePath)​
  • Cake.Common.Tools.DupFinder​.DupFinder(FilePath, ​DupFinderSettings)​
  • Cake.Common.Tools.DupFinder​.DupFinder(IEnumerable<FilePath>)​
  • Cake.Common.Tools.DupFinder​.DupFinder(IEnumerable<FilePath>, ​DupFinderSettings)​
  • Cake.Common.Tools.DupFinder​.DupFinder(string)​
  • Cake.Common.Tools.DupFinder​.DupFinder(string, ​DupFinderSettings)​
  • Cake.Common.Tools.DupFinder​.DupFinderFromConfig(FilePath)​
  • Cake.Common.Tools.Fixie​.Fixie(string)​
  • Cake.Common.Tools.Fixie​.Fixie(string, ​FixieSettings)​
  • Cake.Common.Tools.Fixie​.Fixie(IEnumerable<string>)​
  • Cake.Common.Tools.Fixie​.Fixie(IEnumerable<FilePath>)​
  • Cake.Common.Tools.Fixie​.Fixie(IEnumerable<string>, ​FixieSettings)​
  • Cake.Common.Tools.Fixie​.Fixie(IEnumerable<FilePath>, ​FixieSettings)​
  • Cake.Common.Tools.InspectCode​.InspectCode(FilePath)​
  • Cake.Common.Tools.InspectCode​.InspectCode(FilePath, ​InspectCodeSettings)​
  • Cake.Common.Tools.InspectCode​.InspectCodeFromConfig(FilePath)​
  • Cake.Common.Tools.NSIS​.MakeNSIS(FilePath)​
  • Cake.Common.Tools.NSIS​.MakeNSIS(FilePath, ​MakeNSISSettings)​
  • Cake.Common.Xml​.XmlTransform(string, ​string)​
  • Cake.Common.Xml​.XmlTransform(string, ​string, ​XmlTransformationSettings)​
  • Cake.Common.Xml​.XmlTransform(FilePath, ​FilePath, ​FilePath)​
  • Cake.Common.Xml​.XmlTransform(FilePath, ​FilePath, ​FilePath, ​XmlTransformationSettings)​
  • Cake.Common.Xml​.XmlPeek(FilePath, ​string)​
  • Cake.Common.Xml​.XmlPeek(FilePath, ​string, ​XmlPeekSettings)​
This was referenced Mar 23, 2016
Merged
Merged
Merged
Merged
This was referenced Mar 26, 2016
Merged
Closed
m-ritchie added a commit to m-ritchie/cake that referenced this issue Mar 27, 2016
@m-ritchie
Alias examples for MSTest cake-build#750
ffc6fce 
Cake.Common.Tools.MSTest​.MSTest(string)​
Cake.Common.Tools.MSTest​.MSTest(string, ​MSTestSettings)​
Cake.Common.Tools.MSTest​.MSTest(IEnumerable<FilePath>)​
Cake.Common.Tools.MSTest​.MSTest(IEnumerable<FilePath>, ​MSTestSettings)
m-ritchie added a commit to m-ritchie/cake that referenced this issue Mar 28, 2016
@m-ritchie
Alias examples for MSTest cake-build#750
471fd0c 
Cake.Common.Tools.MSTest​.MSTest(string)​
Cake.Common.Tools.MSTest​.MSTest(string, ​MSTestSettings)​
Cake.Common.Tools.MSTest​.MSTest(IEnumerable<FilePath>)​
Cake.Common.Tools.MSTest​.MSTest(IEnumerable<FilePath>, ​MSTestSettings)
m-ritchie added a commit to m-ritchie/cake that referenced this issue Mar 28, 2016
@m-ritchie
Alias examples for MSTest cake-build#750
f682d93 
Cake.Common.Net​.DownloadFile(string)​
Cake.Common.Net​.DownloadFile(Uri)​
Cake.Common.Net​.DownloadFile(string, ​FilePath)​
Cake.Common.Net​.DownloadFile(Uri, ​FilePath)
Cake.Common.Tools​.DotNetBuild(FilePath)​
Cake.Common.Tools​.DotNetBuild(FilePath, ​Action<DotNetBuildSettings>)​
Cake.Common.Tools.MSTest​.MSTest(string)​
Cake.Common.Tools.MSTest​.MSTest(string, ​MSTestSettings)​
Cake.Common.Tools.MSTest​.MSTest(IEnumerable<FilePath>)​
Cake.Common.Tools.MSTest​.MSTest(IEnumerable<FilePath>, ​MSTestSettings)

Updated examples in HttpAliases and DotNetBuildAliases
@patriksvensson patriksvensson mentioned this issue Mar 28, 2016
Merged
@gep13 gep13 mentioned this issue Mar 29, 2016
Merged
gep13 added a commit to gep13/cake that referenced this issue Mar 29, 2016
@gep13
(cake-buildGH-750) Added DupFinder Sample Code
9860aee
gep13 added a commit to gep13/cake that referenced this issue Mar 30, 2016
@gep13
(cake-buildGH-750) Corrected Alias used in Example
fbc280d
gep13 added a commit to gep13/cake that referenced this issue Mar 30, 2016
@gep13
(cake-buildGH-750) Removed whitespace
85bb33d
gep13 added a commit to gep13/cake that referenced this issue Mar 30, 2016
@gep13
(cake-buildGH-750) Added examples for InspectCode
86c37dc
@gep13 gep13 mentioned this issue Mar 30, 2016
Merged
m-ritchie added a commit to m-ritchie/cake that referenced this issue Apr 2, 2016
@m-ritchie
cake-buildGH-750 alias examples for NuGet, NUnit, WiX
1815f6e
m-ritchie added a commit to m-ritchie/cake that referenced this issue Apr 2, 2016
@m-ritchie
cake-buildGH-750 alias examples for NuGet, NUnit, WiX
66844a9
@m-ritchie m-ritchie mentioned this issue Apr 2, 2016
Merged
m-ritchie added a commit to m-ritchie/cake that referenced this issue Apr 2, 2016
@m-ritchie
cake-buildGH-750 alias examples for NuGet, NUnit, WiX
0364ce5 
Fixed previous typo.
gep13 added a commit that referenced this issue Apr 3, 2016
@gep13
Merge pull request #804 from UnbelievablyRitchie/feature/gh750
08c0735 
GH-750 alias examples for NuGet, NUnit, WiX
@luisgoncalves
Copy link
Contributor

@patriksvensson @gep13 Cake.Common​.StartProcess(FilePath, ​ProcessSettings, ​out IEnumerable)​ already has the example, but it's not showing on the site. Was added here.

@gep13
Copy link
Member

gep13 commented Jul 14, 2016

@luisgoncalves you are right, this does seem a little strange.

@devlead @patriksvensson any thoughts on why this wouldn't be showing up?

@phillipsj
Copy link
Contributor

@patriksvensson @gep13 Looks like NUnit3 can be marked on the list as completed.

@gep13
Copy link
Member

gep13 commented Jul 19, 2016

@phillipsj said...
@patriksvensson @gep13 Looks like NUnit3 can be marked on the list as completed.

Yip, I think you are right 👍

gep13 pushed a commit that referenced this issue Jul 19, 2016
@phillipsj @gep13
GH-750 alias examples for Fixie
a91a1e9 
Adding the examples for Fixie to the alias file.
@gep13 gep13 mentioned this issue Jul 19, 2016
Closed
@gep13 gep13 modified the milestone: v0.15.0 Jul 19, 2016
@gep13 gep13 mentioned this issue Jul 19, 2016
Closed
devlead added a commit that referenced this issue Jul 20, 2016
@devlead
Merge pull request #1082 from phillipsj/feature-remaining-documentation
0a6b68c 
GH-750 Remaining documentation
@gep13
Copy link
Member

gep13 commented Jul 20, 2016

Huge thanks to everyone who helped out in getting this documentation effort completed! 😄

@gep13 gep13 closed this as completed Jul 20, 2016
gep13 added a commit that referenced this issue Jul 20, 2016
@gep13
(GH-750) Corrected Alias Documentation
de5a77e 
It was referencing MSBuild, when it should be using XBuild
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v0.15.0
Development

No branches or pull requests
4 participants
@patriksvensson @gep13 @phillipsj @luisgoncalves