mirror of
https://github.com/minio/docs.git
synced 2025-10-26 20:12:23 +03:00
Attempting to reduce docs to single platform (#1258)
##
We are going to make the following changes to the Object Store docs as
part of a larger QC/Content pass:
### Left Navigation
We want to modify the left navigation flow to be a natural progression
from a basic setup to more advanced.
For example:
- Core Concepts
- Deployment Architecture
- Availability and Resiliency
- Erasure Coding and Object Healing
- Object Scanner
- Site Replication and Failover
- Thresholds and Limits
- Installation
- Deployment Checklist
- Deploy MinIO on Kubernetes
- Deploy MinIO on Red Hat Linux
- Deploy MinIO on Ubuntu Linux
- Deploy MinIO for Development (MacOS, Windows, Container)
- Security and Encryption (Conceptual Overview)
- Network Encryption (TLS) (Conceptual overview)
- Enable Network Encryption using Single Domain
- Enable Network Encryption using Multiple Domains
- Enable Network Encryption using certmanager (Kubernetes only)
- Data Encryption (SSE) (Conceptual overview)
- Enable SSE using AIStor Key Management Server
- Enable SSE using KES (Summary page + linkouts)
- External Identity Management (Conceptual Overview)
- Enable External Identity management using OpenID
- Enable External Identity management using AD/LDAP
- Backup and Recovery
- Create a Multi-Site Replication Configuration
- Recovery after Hardware Failure
- Recover after drive failure
- Recover after node failure
- Recover after site failure
- Monitoring and Alerts
- Metrics and Alerting (v3 reference)
- Monitoring and Alerting using Prometheus
- Monitoring and Alerting using InfluxDB
- Monitoring and Alerting using Grafana
- Metrics V2 Reference
- Publish Server and Audit Logs to External Services
- MinIO Healthcheck API
The Administration, Developer, and Reference sections will remain as-is
for now.
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
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Rushan <rushenn@minio.io>
Co-authored-by: rushenn <rushenn123@gmail.com>
This commit is contained in:
Ravind Kumar
GitHub
@@ -71,6 +71,7 @@ extlinks = {
|
||||
'eks-docs' : ('https://docs.aws.amazon.com/eks/latest/userguide/%s', None),
|
||||
'minio-web' : ('https://min.io/%s?ref=docs', None),
|
||||
'minio-docs' : ('https://min.io/docs/%s?ref=docs-internal', None),
|
||||
'minio-blog' : ('https://blog.min.io/%s?ref=docs', None),
|
||||
'gke-docs' : ('https://cloud.google.com/kubernetes-engine/docs/%s', None),
|
||||
'gcp-docs' : ('https://cloud.google.com/compute/docs/%s', None),
|
||||
'gcs-docs' : ('https://cloud.google.com/storage/docs/%s', None),
|
||||
@@ -106,78 +107,6 @@ sitemap_url_scheme = "{link}"
|
||||
|
||||
excludes = []
|
||||
|
||||
if tags.has("linux"):
|
||||
html_baseurl = 'https://min.io/docs/minio/linux/'
|
||||
with open('url-excludes.yaml','r') as f:
|
||||
for i in (yaml.safe_load_all(f)):
|
||||
if i['tag'] == 'linux':
|
||||
excludes = i['excludes']
|
||||
break
|
||||
|
||||
elif tags.has("macos"):
|
||||
html_baseurl = 'https://min.io/docs/minio/macos/'
|
||||
with open('url-excludes.yaml','r') as f:
|
||||
for i in (yaml.safe_load_all(f)):
|
||||
if i['tag'] == 'macos':
|
||||
excludes = i['excludes']
|
||||
break
|
||||
|
||||
elif tags.has("windows"):
|
||||
# html_baseurl is used for generating the sitemap.xml for each platform. These are combined in a sitemapindex.xml.
|
||||
html_baseurl = 'https://min.io/docs/minio/windows/'
|
||||
with open('url-excludes.yaml','r') as f:
|
||||
for i in (yaml.safe_load_all(f)):
|
||||
if i['tag'] == 'windows':
|
||||
excludes = i['excludes']
|
||||
break
|
||||
|
||||
elif tags.has("container"):
|
||||
html_baseurl = 'https://min.io/docs/minio/container/'
|
||||
with open('url-excludes.yaml','r') as f:
|
||||
for i in (yaml.safe_load_all(f)):
|
||||
if i['tag'] == 'container':
|
||||
excludes = i['excludes']
|
||||
break
|
||||
|
||||
elif tags.has("k8s") and not (tags.has("openshift") or tags.has("eks") or tags.has("gke") or tags.has("aks")):
|
||||
html_baseurl = 'https://min.io/docs/minio/kubernetes/upstream/'
|
||||
with open('url-excludes.yaml','r') as f:
|
||||
for i in (yaml.safe_load_all(f)):
|
||||
if i['tag'] == 'k8s':
|
||||
excludes = i['excludes']
|
||||
break
|
||||
|
||||
elif tags.has("openshift"):
|
||||
html_baseurl = 'https://min.io/docs/minio/kubernetes/openshift/'
|
||||
with open('url-excludes.yaml','r') as f:
|
||||
for i in (yaml.safe_load_all(f)):
|
||||
if i['tag'] == 'openshift':
|
||||
excludes = i['excludes']
|
||||
break
|
||||
|
||||
elif tags.has("eks"):
|
||||
html_baseurl = 'https://min.io/docs/minio/kubernetes/eks/'
|
||||
with open('url-excludes.yaml','r') as f:
|
||||
for i in (yaml.safe_load_all(f)):
|
||||
if i['tag'] == 'eks':
|
||||
excludes = i['excludes']
|
||||
break
|
||||
|
||||
elif tags.has("gke"):
|
||||
html_baseurl = 'https://min.io/docs/minio/kubernetes/gke/'
|
||||
with open('url-excludes.yaml','r') as f:
|
||||
for i in (yaml.safe_load_all(f)):
|
||||
if i['tag'] == 'gke':
|
||||
excludes = i['excludes']
|
||||
break
|
||||
|
||||
elif tags.has("aks"):
|
||||
html_baseurl = 'https://min.io/docs/minio/kubernetes/aks/'
|
||||
with open('url-excludes.yaml','r') as f:
|
||||
for i in (yaml.safe_load_all(f)):
|
||||
if i['tag'] == 'aks':
|
||||
excludes = i['excludes']
|
||||
break
|
||||
|
||||
exclude_patterns.extend(excludes)
|
||||
|
||||
@@ -246,56 +175,20 @@ html_js_files = [
|
||||
# Add https://www.min.io/robots.txt to html_extra_path list once available.
|
||||
html_extra_path = [ 'extra']
|
||||
|
||||
html_baseurl = 'https://docs.min.io/community/minio-object-store'
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
# We assume a single tag, since we control the builder
|
||||
|
||||
platform = list(tags.tags.keys())[0]
|
||||
|
||||
platform_fmt = ""
|
||||
|
||||
if platform == "k8s":
|
||||
platform_fmt = "Kubernetes"
|
||||
elif platform == "macos":
|
||||
platform_fmt = "MacOS"
|
||||
elif platform == "openshift":
|
||||
platform_fmt = "OpenShift"
|
||||
elif platform == "eks":
|
||||
platform_fmt = "Elastic Kubernetes Service"
|
||||
elif platform == "gke":
|
||||
platform_fmt = "Google Kubernetes Engine"
|
||||
elif platform == "aks":
|
||||
platform_fmt = "Azure Kubernetes Service"
|
||||
else:
|
||||
platform_fmt = platform.capitalize()
|
||||
|
||||
project = 'MinIO Documentation for ' + platform_fmt
|
||||
project = 'Documentation for MinIO Object Storage'
|
||||
copyright = '2020-Present, MinIO, Inc. '
|
||||
author = 'MinIO Documentation Team'
|
||||
html_title = 'MinIO Object Storage for ' + platform_fmt
|
||||
html_short_title = 'MinIO Object Storage for ' + platform_fmt
|
||||
html_title = 'MinIO Object Storage (AGPLv3)'
|
||||
html_short_title = 'MinIO Object Storage'
|
||||
|
||||
html_permalinks_icon = ''
|
||||
|
||||
html_context = {
|
||||
'doc_platform': platform.lower(),
|
||||
'docs': [
|
||||
# The first item has to be the current docs site #
|
||||
{
|
||||
'name': 'MinIO Server',
|
||||
'current': True
|
||||
},
|
||||
{
|
||||
'name': 'DirectPV',
|
||||
'url': 'https://min.io/docs/directpv',
|
||||
'external': True
|
||||
},
|
||||
{
|
||||
'name': 'KES',
|
||||
'url': 'https://min.io/docs/kes',
|
||||
'external': True
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
# -- Options for Sphinx Tabs -------------------------------------------------
|
||||
@@ -306,14 +199,9 @@ sphinx_tabs_disable_css_loading = True
|
||||
|
||||
# k8s is temporary until integrating the references here
|
||||
|
||||
intersphinx_mapping = {
|
||||
'linux' : ('https://min.io/docs/minio/linux/', None),
|
||||
'kubernetes' : ('https://min.io/docs/minio/kubernetes/upstream/',None)
|
||||
}
|
||||
|
||||
rst_prolog = """
|
||||
|
||||
.. |platform| replace:: %s
|
||||
.. |platform| replace:: 'foo'
|
||||
|
||||
.. |podman| replace:: `Podman <https://podman.io/>`__
|
||||
|
||||
@@ -323,10 +211,18 @@ rst_prolog = """
|
||||
.. |minio-latest| replace:: MINIOLATEST
|
||||
.. |minio-rpm| replace:: RPMURL
|
||||
.. |minio-deb| replace:: DEBURL
|
||||
.. |minio-rpmarm64| replace:: RPMARM64URL
|
||||
.. |minio-debarm64| replace:: DEBARM64URL
|
||||
.. |subnet| replace:: `MinIO pricing <https://min.io/pricing?jmp=docs>`__
|
||||
.. |subnet-short| replace:: `pricing <https://min.io/pricing?jmp=docs>`__
|
||||
.. |minio-binary| replace:: MINIOURL
|
||||
.. |minio-rpm-arm64| replace:: RPMARM64URL
|
||||
.. |minio-deb-arm64| replace:: DEBARM64URL
|
||||
.. |minio-binary-arm64| replace:: MINIOARM64URL
|
||||
.. |minio-rpm-ppc64le| replace:: RPMPPC64LEURL
|
||||
.. |minio-deb-ppc64le| replace:: DEBPPC64LEURL
|
||||
.. |minio-binary-ppc64le| replace:: MINIOPPC64LEURL
|
||||
.. |minio-rpms-390x| replace:: RPMS390XURL
|
||||
.. |minio-debs-390x| replace:: DEBS390XURL
|
||||
.. |minio-binarys-390x| replace:: MINIOS390XURL
|
||||
.. |subnet| replace:: `MinIO SUBNET <https://min.io/pricing?jmp=docs>`__
|
||||
.. |subnet-short| replace:: `SUBNET <https://min.io/pricing?jmp=docs>`__
|
||||
.. |SNSD| replace:: :abbr:`SNSD (Single-Node Single-Drive)`
|
||||
.. |SNMD| replace:: :abbr:`SNMD (Single-Node Multi-Drive)`
|
||||
.. |MNMD| replace:: :abbr:`MNMD (Multi-Node Multi-Drive)`
|
||||
@@ -348,4 +244,4 @@ rst_prolog = """
|
||||
.. |rust-sdk-version| replace:: RUSTVERSION
|
||||
|
||||
|
||||
""" % platform_fmt
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user