Simplify Build for New Contributors #513
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -32,11 +32,11 @@ | |||
| <!-- Runtime libraries --> | |||
| <file src="bin\v3.5\$Configuration$\openstacknet.dll" target="lib\net35"/> | |||
| <file src="bin\v3.5\$Configuration$\openstacknet.pdb" target="lib\net35"/> | |||
| <file src="..\..\docs\Api\v3.5\openstacknet.xml" target="lib\net35"/> | |||
| <file src="bin\v3.5\$Configuration$\openstacknet.xml" target="lib\net35"/> | |||
There was a problem hiding this comment.
This change will cause the NuGet package to not include XML documentation for methods in the SDK which use <inheritdoc/>.
There was a problem hiding this comment.
Thanks, I wasn't aware that we were relying that deeply on Sandcastle with respect to the inline doc and assumed it was just for the openstack.net/docs site.
The goal is to simplify the contributor experience. A developer with Visual Studio installed should be able to clone and execute build.cmd (or build.sh) without additional flags and it should "just work".
* Move documentation projects into separate solution * Use NuGet to download SHFB * Host custom build of SHFB on myget.org openstacknetsdk feed
83162b8 to
3da2c6e
Compare
|
Updated PR
|
carolynvs
added a commit
that referenced
this pull request
Jun 22, 2015
Simplify Build for New Contributors
|
Looks good to me. |
This was referenced Jun 24, 2015
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The goal is that a new contributor can simply clone and execute
build.cmdwithout any additional arguments or prerequisites. Eventually I would like to better match the new/proposed .NET project structure and this is a first step.The biggest changes are: