Skip to content

Commit

Permalink
Update navigation links in config.ts for Community Engagement and API
Browse files Browse the repository at this point in the history
  • Loading branch information
tygastoFX committed Apr 17, 2024
1 parent 108a71b commit 43d259b
Show file tree
Hide file tree
Showing 13 changed files with 229 additions and 37 deletions.
8 changes: 4 additions & 4 deletions .web/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -226,24 +226,24 @@ export default defineConfig({
},
{
text: 'Launch Guides', link: '/browser/launch/', items: [
{text: 'Prerequisites', link: '/browser/launch/prerequisites'},
{text: 'Launch Your Server', link: '/browser/launch/server'},
{text: 'Launch Your Game', link: '/browser/launch/game'},
]
},
{
text: 'Community Engagement', link: '/browser/engage/', items: [
{text: 'Best Practices', link: '/browser/engage/tips'},
{text: 'Update Launches', link: '/browser/engage/server'},
{text: 'Event Management', link: '/browser/engage/game'},
{text: 'Update Launches', link: '/browser/engage/updates'},
{text: 'Event Management', link: '/browser/engage/events'},
]
},
{
text: 'API', link: '/browser/api/', items: [
{text: 'Authentication', link: '/browser/api/server'},
{text: 'Authentication', link: '/browser/api/auth'},
{text: 'Versioning', link: '/browser/api/versions'},
{text: 'Endpoints', link: '/browser/api/endpoints'},
{text: 'Rate Limits', link: '/browser/api/ratelimits'},
{text: 'SDK and Resources', link: '/browser/api/developers'},
]
},
{
Expand Down
42 changes: 42 additions & 0 deletions .web/docs/browser/api/auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Minekube Browser - API Authentication

## Overview
Authentication in the Minekube Browser API is handled through API keys. This section explains how to obtain and use your API keys to access the API securely.

## Generating API Keys
1. **Login to Dashboard:** Access the [Minekube Dashboard](https://dashboard.minekube.com) with your user credentials.
2. **Navigate to API Section:** Locate the API management section.
3. **Create New Key:** Follow the prompts to generate a new API key.
4. **Set Permissions:** Assign the necessary permissions based on your application needs.

## Using API Keys
- **Include in Headers:** Always include your API key in the request headers:
```http
Authorization: Bearer <your_api_key>
### Endpoint Protection
- **Unauthorized Access:** All protected endpoints will return a `401 Unauthorized` response if a valid API key is not included in the request headers.
## Rate Limiting
- **Purpose:** To prevent abuse and ensure fair usage, API requests are rate-limited. View specific rate limit details in the [Rate Limits](ratelimits.md) section.
- **Limits:** Rate limits are defined by the number of requests per minute, varying by API key.
## Security Best Practices:
::: tip
**Ensure secure storage of your API keys to prevent unwanted abuse. View our [Security Guide](../../guide/protections.html) for more info**
:::
### 1. Key Rotation
- **Security Recommendation:** Periodic rotation of API keys is advised to maintain security.
- **Regeneration:** Keys can be regenerated through the dashboard as needed.
### 2. IP Whitelisting
- **Added Security:** API keys can be associated with specific IP addresses or ranges, restricting access to whitelisted IPs only.
### 3. Fine Tuned Access
- **Access Control:** API keys are assigned different permission levels to control access to various endpoints or features within your [Minekube Organization](../../guide/quick-start.md).
## Next Steps
- **API Versioning:** Detailed documentation on versioning for proper use of API keys is available in the [Versioning](./versions.md) section.
- **API Endpoints:** View available endpoints and example responses in [Endpoints](./endpoints.md) section.
16 changes: 16 additions & 0 deletions .web/docs/browser/api/developers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Minekube Browser - SDK and Resources

## Overview
We provide SDKs and additional resources to facilitate easy integration of our API into your applications.

## SDK Downloads
Download our SDKs tailored for different programming environments:

- [Java SDK](/browser/api/developers/java)

## Integration Examples
Example using the Java SDK to access server listings:

```java
MinekubeAPI api = new MinekubeAPI("<your_api_key>");
ServerList servers = api.getServers();
49 changes: 49 additions & 0 deletions .web/docs/browser/api/endpoints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Brower API Endpoints

The Minekube Browser API provides a range of endpoints to interact with the platform:

## Server Listing

### `GET /servers`
- **Description:** Retrieve a list of all public servers.

### `GET /servers/{id}`
- **Description:** Get details of a specific server by its ID.

## User Authentication

### `POST /auth/login`
- **Description:** Authenticate a user and retrieve an access token.

### `GET /auth/me`
- **Description:** Get the currently authenticated user's details.

### `PUT /auth/me`
- **Description:** Update the currently authenticated user's details.

## Server Management

### `GET /my-servers`
- **Description:** Retrieve a list of servers owned by the authenticated user.

### `GET /my-servers/{id}`
- **Description:** Get details of a specific server owned by the authenticated user.

### `PUT /my-servers/{id}`
- **Description:** Update the details of a specific server owned by the authenticated user.

## Player Statistics

### `GET /stats/players`
- **Description:** Retrieve overall player statistics, including total players, online players, and unique players.

### `GET /stats/players/top`
- **Description:** Get a list of the top servers by player count.

## Error Responses

- **400 Bad Request:** Invalid request format or missing parameters.
- **401 Unauthorized:** Authentication failed or invalid API key.
- **403 Forbidden:** Access forbidden due to insufficient permissions.
- **404 Not Found:** Requested resource not found.
- **500 Internal Server Error:** An unexpected server error occurred.
64 changes: 64 additions & 0 deletions .web/docs/browser/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Minekube Browser - API Documentation

Welcome to the Minekube Browser API documentation. This guide provides all the necessary details to integrate with our API, focusing on server listings initially, with plans to expand to games, plugins, and mods.

## Table of Contents

- [Authentication](#authentication)
- [Versioning](#versioning)
- [Endpoints](#endpoints)
- [Rate Limits](#rate-limits)
- [SDK and Resources](#sdk-and-resources)

## Authentication

Secure access to the API is controlled through API keys and other authentication mechanisms. Here, you'll find how to obtain and manage your API keys, including:

- **Generating API Keys:** Step-by-step guide to generate your unique API keys through the Minekube Browser dashboard.
- **Using API Keys:** How to include your API key in API requests to authenticate.
- **Security Best Practices:** Recommendations for securing your API keys.

[Explore Authentication Details](/browser/api/auth)

## Versioning

To maintain stability and backward compatibility, our API implements a versioning system. This section covers:

- **Version Formats:** Explanation of our semantic versioning format.
- **Handling Versions:** How to specify API versions in your requests.
- **Deprecation and Migration:** Guidelines on deprecated features and migrating to newer API versions.

[Learn More About Versioning](/browser/api/versions)

## Endpoints

This section describes all the available API endpoints, their functions, and how to use them. Highlights include:

- **Server Listing Endpoints:** Access information about servers, including details, listings, and management functions.
- **User and Authentication Endpoints:** How to manage user authentication and user-specific data.

[Detailed Endpoint Information](/browser/api/endpoints)

## Rate Limits

Understanding the rate limits is crucial to ensure fair use and system stability. This section provides:

- **Rate Limit Rules:** Specific limits on the number of requests that can be made to the API.
- **Best Practices:** Tips on how to handle and respond to rate limit conditions.

[Check Our Rate Limit Policies](/browser/api/ratelimits)

## SDK and Resources

For developers looking to integrate quickly, we offer SDKs and other resources. This section includes:

- **SDK Downloads:** Links to our official SDKs for various programming environments.
- **Integration Examples:** Practical examples showing how to use the API in common scenarios.
- **Developer Support:** Information on how to get help if you encounter issues or have questions.

[Access SDK and Developer Resources](/browser/api/developers)


## Support
If you have any questions or issues please join our [Discord](https://minekube.com/discord)

Empty file.
38 changes: 38 additions & 0 deletions .web/docs/browser/api/versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Minekube Browser - API Versioning

## Overview
To ensure backward compatibility and smooth updates, the Minekube Browser API follows a clear versioning system.

## Version Numbering
API versions are indicated by a semantic version number, e.g., `v1`, `v2`. This number is included in the base URL of each API endpoint.

## Version Stability
- **Major Updates:** Transitioning from `v1` to `v2` may introduce breaking changes.
- **Minor Updates:** Upgrades such as `v1.0` to `v1.1` will remain backward-compatible.

## Deprecation Policy
Deprecated endpoints or features will be clearly marked in the documentation, including the expected removal date.

## Version Migration
When a new major version is released, a migration path will be provided to help users transition smoothly to the new version.

## Version Header
API requests can include an optional `Accept-Version` header to specify the desired API version. If not provided, the latest stable version will be used.

## Versioning in Responses
API responses may include an `API-Version` header, indicating the version used to process the request.

## Version-Specific Documentation
The API documentation will provide separate sections for each major version, outlining any changes or additions.

## Release Notes
Release notes will be provided for each API version, detailing any changes, improvements, or fixes.

## Sunset Policy
Deprecated versions will continue to be supported for a defined period, after which they may be sunset. Advance notice will be provided before sunsetting a version.

## Client Libraries
Official client libraries will be updated to support new API versions, and older versions will be maintained for a reasonable period.

## Version Negotiation
The API may support version negotiation in the future, allowing clients to specify their preferred version and receive a response in that version.
Empty file.
Empty file.
Empty file.
Empty file.
45 changes: 14 additions & 31 deletions .web/docs/browser/faq/index.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,27 @@
# Launching on Minekube Browser
# Minekube Browser FAQs

Welcome to the definitive guide for launching on the Minekube Browser, the platform that champions innovation and community within the Minecraft universe. This documentation will walk you through the journey of launching your game or server, helping you to capture the attention and imagination of a global audience of Minecraft enthusiasts.
Welcome to the FAQ for Minekube Browser. Here you will find answers to common questions about the platform, its features, and how you can get involved in the community.

## Understanding Launches on Minekube Browser
## What is the Minekube Browser?

On Minekube Browser, launching is about more than just revealing your game or server to the world—it's about creating a moment. A successful launch combines preparation, community interaction, and strategic marketing to make a lasting impact.
>The Minekube Browser is a revolutionary Minecraft server list and marketplace, offering a comprehensive platform for players, developers, and hosting providers. It goes beyond a simple server list by providing tools and services for building, listing, and launching Minecraft games.
### The Launch Types:
## How is Minekube Browser different from other server lists?

- **Game Launch:** Introduce your polished game to the community, ready for players to download, enjoy, and share.
- **Server Launch:** Publicize your server, inviting players to join and partake in the unique experience you've crafted.
> Minekube Browser is more than just a directory of servers. It offers a launchpad for server experiences, providing robust infrastructure services like Minekube Games for server management and Minekube Connect for simplified connectivity. It also focuses on community engagement and offers features to facilitate collaboration and content discovery.
## The Launch Lifecycle
## Who is Minekube Browser for?

Inspired by the proven approach of Product Hunt, the lifecycle of a launch on Minekube Browser is a dynamic process:
> Minekube Browser caters to a wide range of the Minecraft community, including players seeking new adventures, developers crafting game worlds, and hosting providers scaling their services. Our platform is designed to be accessible and beneficial to all segments of the Minecraft community.
1. **Preparation:** Set up your launch page with compelling media, a captivating description, and all the details players need.
2. **Community Building:** Engage with the Minekube community. Connect with players and gather support even before your launch goes live.
3. **Launch Timing:** Choose the perfect time for your launch. While any day can be your launch day, consider aiming for periods of high activity to maximize visibility.
4. **Promotion:** Amplify your launch through your networks. Reach out to your followers, email subscribers, and social media to drive attention and traffic.
5. **Active Engagement:** On launch day, be present to interact with the community. Respond to feedback, answer questions, and foster a conversation around your launch.
## What benefits does Minekube Browser offer to players?

For detailed steps and best practices, visit our [Launching a Game](./game) or [Launching a Server](./server) documentation.
> Players can discover an extensive range of Minecraft games and experiences, all in one place. Minekube Browser offers a curated selection of servers, ensuring a high-quality and diverse gaming experience. Players can also connect with other community members, participate in events, and provide feedback to shape the future of the platform.
## Why Launch with Minekube Browser?
## How can developers benefit from Minekube Browser?

- **Dedicated Audience:** Direct access to a community of avid Minecraft players looking for their next favorite game or server.
- **Robust Platform:** Built on a solid foundation, Minekube Browser ensures that your launch is supported by a seamless and scalable infrastructure.
- **Comprehensive Tools:** From analytics to community feedback, leverage a suite of tools designed to support and enhance your launch.
> Developers can leverage the Minekube Browser platform to showcase their Minecraft creations, gain exposure, and build a dedicated customer base. We provide tools and services to simplify server management, connectivity, and community engagement, allowing developers to focus on crafting immersive games.
## Your Launch Day
## How can I contribute to the Minekube Browser community?

When the big day arrives, it's all about momentum. Encourage your existing audience to visit your launch page, upvote, and leave feedback. The more engagement your launch receives, the more it will be noticed by others in the Minekube community.

## Post-Launch: Sustaining the Hype

The end of launch day isn't the finish line. Continue to engage with the community, roll out updates, and use analytics to inform your growth strategy. Your launch is just the beginning of your journey on Minekube Browser.

## Ready, Set, Launch!

Now that you're equipped with the knowledge and tools for a successful launch, it's time to put your plan into action. Prepare to showcase your game or server to the world, and let's make your launch on Minekube Browser a resounding success.

Remember, a successful launch blends careful planning, exceptional content, and a vibrant community presence. Whether you're introducing a new game or inviting players to your server, Minekube Browser is where your creations take center stage.
> We encourage active participation and feedback from the community. Join our [Discord](https://minekube.com/discord) server to connect with other players, developers, and Minekube team members. You can share your ideas, provide feedback, report issues, and contribute to the overall growth and improvement of the Minekube Browser platform.
4 changes: 2 additions & 2 deletions .web/docs/browser/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to Minekube Browser Documentation
# Minekube Browser Documentation <VPBadge>POC</VPBadge>

::: warning
The Minekube Browser is currently in its developmental phase. We invite you to join our [Discord](https://minekube.com/discord) community and contribute by sharing your valuable feedback!
Expand All @@ -19,4 +19,4 @@ Join us as we explore the features, vision, and community that make Minekube Bro
## Getting Started
Welcome aboard the new chapter of Minecraft server exploration and game building — Welcome to the Minekube Platform.

To get started, check out our **[Quicklaunch Guide](/quickstart)** and **[FAQ](/faq)**.
To get started, check out our [Quicklaunch Guides](./launch/) and [FAQ](./faq/).

0 comments on commit 43d259b

Please sign in to comment.