Skip to content

Commit

Permalink
update getting started, add faq & markdownextradata plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
topi314 committed Aug 21, 2023
1 parent d0050bb commit 8298fcc
Show file tree
Hide file tree
Showing 7 changed files with 89 additions and 33 deletions.
2 changes: 1 addition & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The most noteworthy of these, as well as any features and breaking changes, are
> **Warning**
> This is a beta release, and as such, may contain bugs. Please report any bugs you find to the [issue tracker](https://github.com/lavalink-devs/Lavalink/issues/new/choose).
> For more info on the changes in this release, see [here](api/index.md#v370---v400)
> If you have any question regarding the changes in this release, please ask in the [support server](https://discord.gg/ZW4s47Ppw4) or [GitHub discussions](https://github.com/lavalink-devs/Lavalink/discussions/categories/q-a)
> If you have any question regarding the changes in this release, please ask in the [support server]({{ discord_help }}) or [GitHub discussions](https://github.com/lavalink-devs/Lavalink/discussions/categories/q-a)
Contributors:
[@topi314](https://github.com/topi314), [@freyacodes](https://github.com/freyacodes), [@DRSchlaubi](https://github.com/DRSchlaubi) and [@melike2d](https://github.com/melike2d)
Expand Down
29 changes: 0 additions & 29 deletions docs/getting-started.md

This file was deleted.

46 changes: 46 additions & 0 deletions docs/getting-started/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
description: Lavalink frequently asked questions.
---

# FAQ

## What is Lavalink?

Lavalink is a standalone audio player node that is used to stream music to Discord voice servers. It is written in Java and is based on [lavaplayer](https://github.com/lavalink-devs/lavaplayer) and [koe](https://github.com/KyokoBot/koe).

## What is Lavalink used for?

Lavalink is used to stream music to Discord voice servers. It is used by many Discord music bots, including [FredBoat](https://fredboat.com) and many others.

## How do I install Lavalink?

See the [Getting Started](index.md) for instructions on how to install Lavalink.

## How do I configure Lavalink?

See the [Configuration](../configuration/index.md) page for instructions on how to configure Lavalink.

## How do I connect to Lavalink?

See the [Clients](../clients.md) page for a list of clients that can connect to Lavalink. Each client has its own instructions on how to connect to Lavalink.

## How do I run Lavalink in the background?

See the [Docker](../configuration/docker.md) or [Systemd](../configuration/systemd.md) configuration pages for instructions on how to run Lavalink in the background.

## How do I update Lavalink?

Updating Lavalink is as simple as downloading the latest `Lavalink.jar` from [GitHub](https://github.com/lavalink-devs/Lavalink/releases/latest) and replacing the old jar file with the new one.
When using Docker, you can simply pull the latest image from [GitHub Container Registry](https://github.com/lavalink-devs/Lavalink/pkgs/container/lavalink).

## How do I report a bug?

Open an issue on the [issue tracker](https://github.com/lavalink-devs/Lavalink/issues/new?labels=bug&template=bug_report.md).

## How do I get help?

Join the [Lavalink support Discord]({{ discord_help }}) or open a [GitHub discussion](https://github.com/lavalink-devs/Lavalink/discussions/new?category=q-a).

## How do I get support for a client?

Open an issue on the client's GitHub repository or join the client's support Discord. The [Lavalink support Discord]({{ discord }}) also has a channel for each client where you can get support.
33 changes: 33 additions & 0 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
description: Lavalink getting started guide.
---

# Getting Started

Welcome to the Lavalink Getting Started guide. If you're new to Lavalink, follow these steps to get started:

1. Install Java 17 or higher. You can download it [here](https://www.azul.com/downloads/?package=jdk#zulu).
2. Download the latest `Lavalink.jar` from [GitHub](https://github.com/lavalink-devs/Lavalink/releases/latest).
3. Check out the [configuration](../configuration/index.md) page to learn how to configure Lavalink.
4. Run Lavalink with `java -jar Lavalink.jar`.

Now you can connect to Lavalink with your client. You can find a list of clients [here](../clients.md).

If you want to run the Lavalink server without it closing when you close the terminal, you can see the [Docker](../configuration/docker.md) or [Systemd](../configuration/systemd.md) configuration pages.

## Useful Links

- [Features](https://github.com/lavalink-devs/Lavalink#features): Explore the rich feature set of Lavalink.
- [Clients](../clients.md): Explore Lavalink clients.
- [Plugins](../plugins.md): Explore Lavalink plugins.
- [Changelog](../changelog.md): Stay updated with the latest changes and improvements.
- [API Implementation Guidelines](../api/index.md): Learn about implementing the Lavalink API.
- [Server Configuration](../configuration/index.md): Learn about configuring your Lavalink server.

## Found a Bug?

If you found a bug, please report it on the [issue tracker](https://github.com/lavalink-devs/Lavalink/issues/new?labels=bug&template=bug_report.md).

## Need Help?

Join the [Lavalink support Discord]({{ discord_help }}) or open a [GitHub discussion](https://github.com/lavalink-devs/Lavalink/discussions/new?category=q-a) for help or questions.
7 changes: 6 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ copyright: Copyright © 2017-2021 Lavalink Contributors

nav:
- Home: index.md
- Getting Started: getting-started.md
- Getting Started:
- getting-started/index.md
- FAQ: getting-started/faq.md
- Configuration:
- configuration/index.md
- Binary: configuration/binary.md
Expand All @@ -36,6 +38,8 @@ extra_css:

extra:
homepage: /
discord: https://discord.gg/BTHvsc7WsT
discord_help: https://discord.gg/ZW4s47Ppw4
social:
- icon: fontawesome/brands/github
link: https://github.com/lavalink-devs
Expand Down Expand Up @@ -113,3 +117,4 @@ plugins:
background_color: "#ff624a"
color: "#FFFFFF"
- git-revision-date-localized
- markdownextradata
2 changes: 1 addition & 1 deletion docs/overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h1 id="home__title">Lavalink</h1>
<p class="description">
Standalone audio sending node based on Lavaplayer.
</p>
<a class="md-button md-button--primary" href="getting-started.html" title="Using Lavalink">Get Started</a>
<a class="md-button md-button--primary" href="getting-started/index.html" title="Using Lavalink">Get Started</a>
<a class="md-button md-button--primary" href="configuration/index.html" title="Configure Lavalink">Configuration</a>
<p>
</div>
Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ mkdocs-git-revision-date-localized-plugin
pillow
cairosvg
neoteroi-mkdocs
mkdocs-same-dir
mkdocs-same-dir
mkdocs-markdownextradata-plugin

0 comments on commit 8298fcc

Please sign in to comment.