Browse Source

Add nightly section for clarification

pull/1161/head
Still Hsu 7 years ago
parent
commit
4f55bec6dd
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
9 changed files with 90 additions and 43 deletions
  1. BIN
      docs/guides/getting_started/images/appveyor-artifacts.png
  2. BIN
      docs/guides/getting_started/images/appveyor-nupkg.png
  3. BIN
      docs/guides/getting_started/images/nightlies-vs-note.png
  4. BIN
      docs/guides/getting_started/images/nightlies-vs-step1.png
  5. BIN
      docs/guides/getting_started/images/nightlies-vs-step2.png
  6. BIN
      docs/guides/getting_started/images/nightlies-vs-step4.png
  7. +2
    -43
      docs/guides/getting_started/installing.md
  8. +85
    -0
      docs/guides/getting_started/nightlies.md
  9. +3
    -0
      docs/guides/toc.yml

BIN
docs/guides/getting_started/images/appveyor-artifacts.png View File

Before After
Width: 976  |  Height: 202  |  Size: 7.0 kB

BIN
docs/guides/getting_started/images/appveyor-nupkg.png View File

Before After
Width: 981  |  Height: 342  |  Size: 9.4 kB

BIN
docs/guides/getting_started/images/nightlies-vs-note.png View File

Before After
Width: 1572  |  Height: 191  |  Size: 10 kB

BIN
docs/guides/getting_started/images/nightlies-vs-step1.png View File

Before After
Width: 640  |  Height: 497  |  Size: 13 kB

BIN
docs/guides/getting_started/images/nightlies-vs-step2.png View File

Before After
Width: 744  |  Height: 434  |  Size: 14 kB

BIN
docs/guides/getting_started/images/nightlies-vs-step4.png View File

Before After
Width: 461  |  Height: 334  |  Size: 8.2 kB

+ 2
- 43
docs/guides/getting_started/installing.md View File

@@ -38,26 +38,14 @@ Release builds of Discord.Net will be published to the
[official NuGet feed].

Development builds of Discord.Net, as well as add-ons, will be
published to our [MyGet feed].

* Direct feed link: `https://www.myget.org/F/discord-net/api/v3/index.json`

Not sure how to add a direct feed? See how [with Visual Studio] or
[without Visual Studio].
published to our [MyGet feed]. See
@Guides.GettingStarted.Installation.Nightlies to learn more.

[official NuGet feed]: https://nuget.org
[MyGet feed]: https://www.myget.org/feed/Packages/discord-net
[with Visual Studio]: https://docs.microsoft.com/en-us/nuget/tools/package-manager-ui#package-sources
[without Visual Studio]: #configuring-nuget-without-visual-studio

### [Using Visual Studio](#tab/vs-install)

> [!TIP]
> Don't forget to change your package source if you're installing from
> the developer feed.
> Also make sure to check "Enable Prereleases" if installing a dev
> build!

1. Create a new solution for your bot.
2. In the Solution Explorer, find the "Dependencies" element under your
bot's project.
@@ -69,9 +57,6 @@ Not sure how to add a direct feed? See how [with Visual Studio] or

### [Using JetBrains Rider](#tab/rider-install)

> [!TIP]
> Make sure to check the "Prerelease" box if installing a dev build!

1. Create a new solution for your bot.
2. Open the NuGet window (Tools > NuGet > Manage NuGet packages for
Solution).
@@ -83,28 +68,16 @@ Not sure how to add a direct feed? See how [with Visual Studio] or

### [Using Visual Studio Code](#tab/vs-code)

> [!TIP]
> Don't forget to add the package source to a [NuGet.Config file] if
> you're installing from the developer feed.

1. Create a new project for your bot.
2. Add `Discord.Net` to your .csproj.

[!code[Sample .csproj](samples/project.xml)]

[NuGet.Config file]: #configuring-nuget-without-visual-studio

### [Using dotnet CLI](#tab/dotnet-cli)

> [!TIP]
> Don't forget to add the package source to a [NuGet.Config file] if
> you're installing from the developer feed.

1. Open command-line and navigate to where your .csproj is located.
2. Enter `dotnet add package Discord.Net`.

[NuGet.Config file]: #configuring-nuget-without-visual-studio

***

## Compiling from Source
@@ -174,18 +147,4 @@ are passing into your client.

***

### Configuring NuGet without Visual Studio

If you plan on deploying your bot or developing outside of Visual
Studio, you will need to create a local NuGet configuration file for
your project.

To do this, create a file named `NuGet.Config` alongside the root of
your application, where the project is located.

Paste the following snippets into this configuration file, adding any
additional feeds if necessary.

[!code[NuGet Configuration](samples/nuget.config)]

[.NET Core SDK]: https://www.microsoft.com/net/download/

+ 85
- 0
docs/guides/getting_started/nightlies.md View File

@@ -0,0 +1,85 @@
---
uid: Guides.GettingStarted.Installation.Nightlies
title: Installing Nightly Build
---

# Installing Discord.Net Nightly Build

Before Discord.Net pushes a new set of features into the stable
version, we use nightly builds to test the features with the
community for an extensive period of time. Each nightly build is
compiled by AppVeyor whenever a new commit is made and will be pushed
to our MyGet feed.

> [!IMPORTANT]
> Before beginning, it is important to note that although nightlies
> are generally stable and have more features and bug fixes than
> the current stable build on NuGet, there **will** be breaking
> changes during the development or breaking bugs. Although breaking
> bugs are usually fixed as soon as they are discovered. It is still
> important to keep this in mind.

## Installing with MyGet (Recommended)

MyGet is typically used by many development teams to publish their
latest pre-release packages before the features are finalized and
pushed to NuGet.

The following is the feed link of Discord.Net,

* `https://www.myget.org/F/discord-net/api/v3/index.json`

Depending on which IDE you use, there are many different ways of
adding the feed to your package source.

### [Visual Studio](#tab/vs)

1. Go to `Tools` > `NuGet Package Manager` > `Package Manager Settings`
![VS](images/nightlies-vs-step1.png)
2. Go to `Package Sources`
![Package Sources](images/nightlies-vs-step2.png)
3. Click on the add icon
4. Fill in the desired name and source as shown below and hit `Update`
![Add Source](images/nightlies-vs-step4.png)

> [!NOTE]
> Remember to tick the `Include prerelease` checkbox to see the
> nightly builds!
> ![Checkbox](images/nightlies-vs-note.png)

### [Local NuGet.Config](#tab/local-nuget-config)

If you plan on deploying your bot or developing outside of Visual
Studio, you will need to create a local NuGet configuration file for
your project.

To do this, create a file named `NuGet.Config` alongside the root of
your application, where the project is located.

Paste the following snippets into this configuration file, adding any
additional feeds if necessary.

[!code[NuGet Configuration](samples/nuget.config)]

After which, you may install the packages by directly modifying the
project file, using the dotnet CLI (`dotnet add package Discord.Net`),
or by using PowerShell (`Install-Package Discord.Net -Prerelease`).

***

## Installing from AppVeyor Artifacts

As mentioned in the first paragraph, we utilize AppVeyor to perform
automated test and build publishing. During the publishing process,
we also upload the NuGet packages onto AppVeyor's Artifact collection.

The latest build status can be found within our [AppVeyor project].

[AppVeyor project]: https://ci.appveyor.com/project/rogueexception/discord-net

1. In the project, you may find our latest build including the
aforementioned artifacts.
![Artifacts](images/appveyor-artifacts.png)
2. In the artifacts collection, you should see the latest packages
packed in `*.nupkg` form which you could download from and use.
![NuPkgs](images/appveyor-nupkg.png)

+ 3
- 0
docs/guides/toc.yml View File

@@ -4,6 +4,9 @@
items:
- name: Installation
topicUid: Guides.GettingStarted.Installation
items:
- name: Nightly Builds
topicUid: Guides.GettingStarted.Installation.Nightlies
- name: Your First Bot
topicUid: Guides.GettingStarted.FirstBot
- name: Terminology


Loading…
Cancel
Save