Attempting to reduce docs to single platform #1258
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ravindk89
force-pushed
the
singleplat
branch
2 times, most recently
from
d7917d3 to
5aef7ed
Compare
feorlen
reviewed
Jul 18, 2024
|
|
||
| This site documents Operations, Administration, and Development of MinIO deployments on Containers for the latest stable version of MinIO: |minio-tag|. | ||
| MinEOS include |SUBNET| access for 24/7 L1 support from MinIO Engineering, with 4 or 1 hour SLAs available based on deployment size. |
There was a problem hiding this comment.
I thought 1 hour was going away?
There was a problem hiding this comment.
Whoops - yeah, 24 / 4. Will patch this.
feorlen
reviewed
Jul 18, 2024
source/index.rst
Outdated
| This site documents Operations, Administration, and Development of MinIO deployments on `Google Kubernetes Engine <https://cloud.google.com/kubernetes-engine>`__ for the latest stable version of the MinIO Operator: |operator-version-stable|. | ||
| - | :ref:`Red Hat Enterprise Linux <deploy-minio-rhel>` | ||
| | :ref:`Ubuntu Linux <deploy-minio-ubuntu>` | ||
| | :ref:`MacOS <deploy-minio-macos>` |
There was a problem hiding this comment.
This makes macOS and Windows seem like first class production platforms 🤔
feorlen
reviewed
Jul 18, 2024
|
|
||
| .. include:: /includes/macos/quickstart.rst | ||
| Follow the instructions on the `MinIO Download Page <https://min.io/downloads?ref=docs>` for your operating system to download and install the :mc:`minio server` process. |
There was a problem hiding this comment.
Suggested change
| Follow the instructions on the `MinIO Download Page <https://min.io/downloads?ref=docs>` for your operating system to download and install the :mc:`minio server` process. | |
| Follow the instructions on the `MinIO Download Page <https://min.io/downloads?ref=docs>`__ for your operating system to download and install the :mc:`minio server` process. |
feorlen
reviewed
Jul 18, 2024
Comment on lines
+44
to
+57
| :ref:`Single-Node Single-Drive <minio-snsd>` (SNSD or "Standalone") | ||
| Local development and evaluation with no/limited reliability | ||
|
|
||
| :ref:`Single-Node Multi-Drive <minio-snmd>` (SNMD or "Standalone Multi-Drive") | ||
| Workloads with lower performance, scale, and capacity requirements | ||
|
|
||
| Drive-level reliability with configurable tolerance for loss of up to 1/2 all drives | ||
|
|
||
| Evaluation of multi-drive topologies and failover behavior. | ||
|
|
||
| :ref:`Multi-Node Multi-Drive <minio-mnmd>` (MNMD or "Distributed") | ||
| Enterprise-grade high-performance object storage | ||
|
|
||
| Multi Node/Drive level reliability with configurable tolerance for loss of up to 1/2 all nodes/drives | ||
|
|
||
| Primary storage for AI/ML, Distributed Query, Analytics, and other Data Lake components | ||
|
|
||
| Scalable for Petabyte+ workloads - both storage capacity and performance |
There was a problem hiding this comment.
maybe make all these unordered lists
Suggested change
| :ref:`Single-Node Single-Drive <minio-snsd>` (SNSD or "Standalone") | |
| Local development and evaluation with no/limited reliability | |
| :ref:`Single-Node Multi-Drive <minio-snmd>` (SNMD or "Standalone Multi-Drive") | |
| Workloads with lower performance, scale, and capacity requirements | |
| Drive-level reliability with configurable tolerance for loss of up to 1/2 all drives | |
| Evaluation of multi-drive topologies and failover behavior. | |
| :ref:`Multi-Node Multi-Drive <minio-mnmd>` (MNMD or "Distributed") | |
| Enterprise-grade high-performance object storage | |
| Multi Node/Drive level reliability with configurable tolerance for loss of up to 1/2 all nodes/drives | |
| Primary storage for AI/ML, Distributed Query, Analytics, and other Data Lake components | |
| Scalable for Petabyte+ workloads - both storage capacity and performance | |
| :ref:`Single-Node Single-Drive <minio-snsd>` (SNSD or "Standalone") | |
| - Local development and evaluation with no/limited reliability | |
| :ref:`Single-Node Multi-Drive <minio-snmd>` (SNMD or "Standalone Multi-Drive") | |
| - Workloads with lower performance, scale, and capacity requirements | |
| - Drive-level reliability with configurable tolerance for loss of up to 1/2 all drives | |
| - Evaluation of multi-drive topologies and failover behavior. | |
| :ref:`Multi-Node Multi-Drive <minio-mnmd>` (MNMD or "Distributed") | |
| - Enterprise-grade high-performance object storage | |
| - Multi Node/Drive level reliability with configurable tolerance for loss of up to 1/2 all nodes/drives | |
| - Primary storage for AI/ML, Distributed Query, Analytics, and other Data Lake components | |
| - Scalable for Petabyte+ workloads - both storage capacity and performance |
|
💯 This is a solid rework, tradeoffs notwithstanding. Let's see what sort of feedback we get from outside docs and reconvene. |
djwfyi
reviewed
Jul 18, 2024
|
|
||
| .. default-domain:: minio | ||
|
|
||
| .. contents:: Table of Contents | ||
| :local: | ||
| :depth: 2 | ||
|
|
||
| MinIO is an object storage solution that provides an Amazon Web Services S3-compatible API and supports all core S3 features. | ||
| MinIO is built to deploy anywhere - public or private cloud, baremetal infrastructure, orchestrated environments, and edge infrastructure. | ||
| MinIO is a Kubernetes-native S3-compatible object storage solution designed to deploy wherever your applications are - on premises, in the private cloud, in the public cloud, and edge infrastructure. |
There was a problem hiding this comment.
Suggested change
| MinIO is a Kubernetes-native S3-compatible object storage solution designed to deploy wherever your applications are - on premises, in the private cloud, in the public cloud, and edge infrastructure. | |
| MinIO is a Kubernetes-native S3-compatible object storage solution designed to deploy wherever your applications are - on premises, in the private cloud, in the public cloud, or on edge infrastructure. |
|
|
||
| .. include:: /includes/container/quickstart.rst | ||
| minio server ~/minio --console-address :9001 | ||
| # For windows, use minio.exe server ~/minio --console-address :9001` |
There was a problem hiding this comment.
Can Windows users to a ~ style path?
Suggested change
| # For windows, use minio.exe server ~/minio --console-address :9001` | |
| # For windows, use `minio.exe server C:\minio --console-address :9001` |
| .. toctree:: | ||
| :titlesonly: | ||
| :hidden: | ||
| .. tab-item:: Kubernetes |
There was a problem hiding this comment.
We want to be Kubernetes forward, so this tab should be selected by default.
Suggested change
| .. tab-item:: Kubernetes | |
| .. tab-item:: Kubernetes | |
| :selected: |
| The file describes two Kubernetes resources: | ||
|
|
||
| - A new namespace ``minio-dev``, and | ||
| - A MinIO pod using a drive or volume on the Worker Node for serving data |
There was a problem hiding this comment.
I feel like we need a step where users kubectl apply the downloaded YAML file.
|
|
||
| See the :ref:`Deploy MinIO Operator <minio-operator-installation>` and :ref:`Minio Tenant deployment guide <minio-k8s-deploy-minio-tenant>` for more information. | ||
|
|
||
| Install a matching version of MinIO across all nodes in the deployment. |
There was a problem hiding this comment.
Since we have multiple products, we should specify which "MinIO" they need to install.
Suggested change
| Install a matching version of MinIO across all nodes in the deployment. | |
| Install a matching version of the MinIO Server across all nodes in the deployment. |
ravindk89
force-pushed
the
singleplat
branch
from
6d41956 to
7be895e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
REVIEW:
Staged
http://192.241.195.202:9000/staging/singleplat/mindocs/index.html
Goals
Maintaining multiple platforms is getting to be too much, and based on analytics the actual number of users taking advantage of it is minimal.
Furthermore, the majority of traffic is to installation pages.
Therefore we're going to try to collapse back into a single MinIO Object Storage product, and use simple navigation and on-page selectors to handle Baremetal vs Kubernetes.
This may also help to eventually stage us to migrate to Hugo + Markdown