The openstack.net SDK, written for the Microsoft .NET platform, is designed to enable developers to seamlessly work with the many services provided by the OpenStack cloud operating system.
The openstack.net SDK contains:
- A language API
- Getting Started Guide
- API Reference Manual
- Release Notes
- Sample code
We welcome and encourage contributions from the developer community. For an overview of the contribution process, including an explanation of our issue labels and common emoji used in discussions, please see CONTRIBUTING.md.
The recommended development environment for this project is Visual Studio 2013 or Visual Studio 2015. When using Visual Studio 2015, a custom analyzer is automatically provided which uses static analysis to identify common mistakes, and in many cases is able to automatically fix the issue.
To edit the documentation projects within Visual Studio, Sandcastle Help File Builder (SHFB) must be installed on the development machine. Currently the project uses a custom build of SHFB. Automated builds do not require manual installation of SHFB, as described below.
The complete project may be built from source using the build.ps1 PowerShell script. In addition to the library
binaries, this script will create the NuGet packages for the SDK. The -InstallSHFB command ensures that the correct
version of SHFB is used for the automated build (and uses NuGet to download it on demand).
cd build
.\build.ps1 -InstallSHFBTo build the project without documentation, use the -NoDocs switch. This switch is equivalent to using the
ReleaseNoDocs solution configuration instead of the normal Release configuration.
cd build
.\build.ps1 -NoDocs