diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae2010e22a..7045c03233 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ The documentation is built using [Sphinx](http://sphinx-doc.org) and [reStructur Once you have cloned the Docs to your local machine, the following instructions will walk you through installing the tools necessary to build and test. -1. [Download python](https://www.python.org/downloads/) version 2.7.10 or higher. +1. [Download python](https://www.python.org/downloads/) version 2.7.10 or higher. (Version 3.4 is recommended.) 2. If you are installing on Windows, add both the Python install directory and the Python scripts directory to your `PATH` environment variable. For example, if you install Python into the c:\python34 directory, you would add `c:\python34;c:\python34\scripts` to your `PATH` environment variable. diff --git a/aspnet/getting-started/installing-on-linux.rst b/aspnet/getting-started/installing-on-linux.rst index eec1e58515..dfbcf1d5c4 100644 --- a/aspnet/getting-started/installing-on-linux.rst +++ b/aspnet/getting-started/installing-on-linux.rst @@ -39,7 +39,7 @@ The .NET Execution Environment (DNX) is used to build and run .NET projects. Use 1. Install the DNX prerequisites:: - sudo apt-get install libunwind8 gettext libssl-dev libcurl3-dev zlib1g libicu-dev + sudo apt-get install libunwind8 gettext libssl-dev libcurl3-dev zlib1g 2. Use DNVM to install DNX for .NET Core:: @@ -105,9 +105,22 @@ Once this step is complete you should be able to run ``dnvm`` and see some help Install the .NET Execution Environment (DNX) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The .NET Execution Environment (DNX) is used to build and run .NET projects. Use DNVM to install DNX for `Mono `_ (see :doc:`choosing-the-right-dotnet`). +The .NET Execution Environment (DNX) is used to build and run .NET projects. Use DNVM to install DNX for `Mono `_ or .NET Core (see :doc:`choosing-the-right-dotnet`). -.. note:: DNX support for .NET Core is not available for CentOS, Fedora and derivative in this release, but will be enabled in a future release. +**To install DNX for .NET Core:** + +1. Install the DNX prerequisites:: + + sudo yum -y install epel-release + sudo yum -y install libunwind gettext libcurl-devel openssl-devel zlib + +.. note:: This will add the epel-release repository to your repo list. + +2. Use DNVM to install DNX for .NET Core:: + + dnvm upgrade -r coreclr + +.. note:: .NET Core on Linux is still in early preview. Please refer to the latest `Release Notes `__ for known issues and limitations. **To install DNX for Mono:** diff --git a/aspnet/getting-started/installing-on-mac.rst b/aspnet/getting-started/installing-on-mac.rst index 88005ca1c0..d419be6368 100644 --- a/aspnet/getting-started/installing-on-mac.rst +++ b/aspnet/getting-started/installing-on-mac.rst @@ -6,8 +6,8 @@ By `Steve Smith`_, `Daniel Roth`_ ASP.NET 5 runs on the .NET Execution Environment (DNX), which is available on multiple platforms, including OS X. This article describes how to install DNX, and therefore ASP.NET 5, on OS X using .NET Core and Mono. In this article: - - `Install the .NET Version Manager (DNVM)`_ - - `Install the .NET Execution Environment (DNX)`_ + - `Install the .NET Version Manager (DNVM)`_ + - `Install the .NET Execution Environment (DNX)`_ Install the .NET Version Manager (DNVM) --------------------------------------- @@ -27,12 +27,7 @@ The .NET Execution Environment (DNX) is used to build and run .NET projects. Use **To install DNX for .NET Core:** -1. Install the DNX prerequisites using `Homebrew `__:: - - brew update - brew install icu4c - -2. Use DNVM to install DNX for .NET Core:: +1. Use DNVM to install DNX for .NET Core:: dnvm upgrade -r coreclr diff --git a/aspnet/getting-started/installing-on-windows.rst b/aspnet/getting-started/installing-on-windows.rst index de6ed2879f..c9f51359c1 100644 --- a/aspnet/getting-started/installing-on-windows.rst +++ b/aspnet/getting-started/installing-on-windows.rst @@ -15,13 +15,13 @@ Install ASP.NET with Visual Studio The easiest way to get started building applications with ASP.NET 5 is to install the latest version of Visual Studio 2015 (including the freely available Community edition). Visual Studio is an Integrated Development Environment (IDE), which means it's not just an editor, but also has many of the tools you need to build applications, in this case ASP.NET 5 web applications. 1. Install `Visual Studio 2015 `__ -2. Install the latest `ASP.NET 5 preview (Beta8) `_ +2. Install the latest `ASP.NET 5 preview (Beta7) `_ When installing Visual Studio 2015, you'll want to be sure to specify that you want to install the Microsoft Web Developer Tools. .. image:: installing-on-windows/_static/web-dev-tools.png -Once Visual Studio is installed, follow the instructions on the Download Center page for installing the latest `ASP.NET 5 preview (Beta8)`_. +Once Visual Studio is installed, follow the instructions on the Download Center page for installing the latest `ASP.NET 5 preview (Beta7)`_. To enable a full command-line experience after installing Visual Studio, open a **Developer Command Prompt for VS2015** and run the following commands:: diff --git a/webhooks/index.rst b/webhooks/index.rst index e93726fdf5..cd06337db5 100644 --- a/webhooks/index.rst +++ b/webhooks/index.rst @@ -14,7 +14,9 @@ ASP.NET WebHooks Documentation :titlesonly: overview + source receiving/index + sending/index diagnostics/index .. include:: /../common/contribute.txt diff --git a/webhooks/overview.rst b/webhooks/overview.rst index 522bff92da..a06dad6eb4 100644 --- a/webhooks/overview.rst +++ b/webhooks/overview.rst @@ -33,7 +33,7 @@ If you only need to receive WebHooks from other services then you can use just the receiver part; if you only want to expose WebHooks for others to consume, then you can do just that. -The code targets ASP.NET Web API 2 and ASP.NET MVC 5 and is available as `OSS on GitHub `_. +The code targets ASP.NET Web API 2 and ASP.NET MVC 5 and is available as `OSS on GitHub `_. WebHooks Overview ----------------- diff --git a/webhooks/receiving/index.rst b/webhooks/receiving/index.rst index b11809c3af..cf5dfebbac 100644 --- a/webhooks/receiving/index.rst +++ b/webhooks/receiving/index.rst @@ -1,5 +1,5 @@ -Receivers ---------- +Receiving WebHooks +------------------ .. include:: /../common/stub-overview.txt diff --git a/webhooks/sending/index.rst b/webhooks/sending/index.rst new file mode 100644 index 0000000000..b47f1386b4 --- /dev/null +++ b/webhooks/sending/index.rst @@ -0,0 +1,10 @@ +Sending WebHooks +---------------- + +.. include:: /../common/stub-overview.txt + +.. toctree:: + :titlesonly: + + senders + diff --git a/webhooks/sending/senders.rst b/webhooks/sending/senders.rst new file mode 100644 index 0000000000..7bc7fc4115 --- /dev/null +++ b/webhooks/sending/senders.rst @@ -0,0 +1,5 @@ +WebHook Senders +=============== + +Please see the blog `Sending WebHooks with ASP.NET WebHooks Preview +`_ for more details. diff --git a/webhooks/source.rst b/webhooks/source.rst new file mode 100644 index 0000000000..5cfab7f5b6 --- /dev/null +++ b/webhooks/source.rst @@ -0,0 +1,26 @@ +Source Code and Nugets +====================== + +Microsoft ASP.NET WebHooks is part of the Microsoft ASP.NET family of modules and is hosted as an +`Open Source Project on GitHub `_. This means that we accept +contributions, but please look at the `Contribution Guidelines `_ +before submitting a pull request. + +This online documentation which you are reading now is also hosted as `Open Source on GitHub `_ +and also accepts contributions. + +Nuget Packages +-------------- + +Microsoft ASP.NET WebHooks is also available as preview Nuget packages which means that you have to select the Preview +flag in Visual Studio in order to see them. + +The `Nuget packages `_ are devided into three parts: + +* `Common `_: A common package that is shared between senders and receivers. + +* `Sender `_ A set of packages supporting sending your own WebHooks to others. + The functionality for sending WebHooks is described in more detail in :doc:`sending/index`. + +* `Receivers `_ A set of packages supporting receiving WebHooks from others. + The functionality for receiving WebHooks is described in more detail in :doc:`receiving/index`.