1
0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +03:00

36 Commits

Author SHA1 Message Date
571f188a4e 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>
2025-07-30 12:33:02 -04:00
b63d6d0f98 Remove top navigation (#1487)
The website menu has been removed from the header as per AB's request.
2025-07-29 12:29:43 -04:00
2470e96a7e Comment dark and read mode 2024-11-13 06:01:42 -08:00
5757f1acf5 Update base theme to match the new website 2024-11-13 06:01:42 -08:00
b4d0a36c71 Allow links into closed tabs (#1126)
JS update to allow a link into a closed tab. 

Tested with 
```
:mc-conf:`~browser.hsts_seconds`
```
which goes to a tab in [this
section](https://min.io/docs/minio/linux/reference/minio-server/settings/console.html#strict-transport-security)

@rushenn Ravind and Andrea came up with this, need a JS intervention to
ensure it's actually reasonable. 🙏🏻

Staged

http://192.241.195.202:9000/staging/link-into-tab/linux/reference/minio-server/settings/console.html#strict-transport-security

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
Co-authored-by: Rushan <rushenn123@gmail.com>
2024-02-23 11:40:26 -07:00
d54b54cafa Light/dark mode: avoid flickering on page reload (#995)
**Current behaviour:**


https://github.com/minio/docs/assets/13393018/1c8b5762-9ee5-45ec-9e44-88f99c1750dd

**Fix:**


https://github.com/minio/docs/assets/13393018/658f7858-d793-40ca-87de-8f519a12dffa
2023-09-11 09:30:27 -04:00
e9fe3bfee2 UI Enhancements: Recommended video section, k8s active class, mobile nav links (#726)
- Give recommended video section a makeover 
<img width="355" alt="Screenshot 2023-02-08 at 14 05 44"
src="https://user-images.githubusercontent.com/13393018/217500836-348b4063-2c54-4b23-8daa-20b127aa7d79.png">

- Fix k8s's active nav state
- Fix nav links wrapping on mobile (current behaviour on production
looks likes below)
<img width="637" alt="Screenshot 2023-02-08 at 11 50 10"
src="https://user-images.githubusercontent.com/13393018/217501024-1b8d21d6-0787-46b0-a8f4-fba8e1086f36.png">
2023-02-14 09:18:50 -06:00
b0282bc30b Add clickable buttons to navigate between images in the carousel (#714)
Preview:
<img width="992" alt="Screenshot 2023-01-25 at 20 03 00"
src="https://user-images.githubusercontent.com/13393018/214613411-28d2b9b9-2031-4d6a-8aac-3ddeea763199.png">

Limitations:
- Arrows are only present on the carousel and not in the Lightbox
preview. In the future, I'll investigate the options for including
arrows on the Light box. For this, we might need to replace the existing
Lightbox plugin with a modern one.
- Loop navigation is not available; instead, arrows will only be shown
when they correspond to the first and last slides.
2023-01-25 11:26:37 -06:00
094d0df6b8 Proof of Concept on right-nav video links via RST + JS (#682) 2022-12-27 13:46:55 -05:00
d3e40ff232 Fix anchor scrolling issue on Webkit browsers (#669) 2022-12-08 12:40:54 -06:00
b7f0c07ec5 UI Enhancements: URLs, Web-font path and CSS fixes (#661)
- Only the external links are set to open in new windows/tab
- Fixed incorrect web-font paths being called for preload. 
- Minor CSS transition fixes.
- Conditionally called the search modal's keyboard events.
2022-12-07 09:47:23 -06:00
594a9cfb6e Replace Algolia DocSearch with InstantSearch (#621)
- Rendered only the relevant search results that has the match-level of
either `full` or `partial`.
- Added refinements to display results from other platforms (Active
platform is selected by default).
- Better title and hierarchical display.

![title](https://user-images.githubusercontent.com/13393018/198229684-3018b591-a54c-4b4f-80db-94c11e33ec65.svg)


- Added icons to represent the hierarchy level.

![icons](https://user-images.githubusercontent.com/13393018/198228150-143153bf-aa9a-4c41-baf8-bd9fa3d33bf2.png)
- Relevant results on full/partial match queries.
<img width="595" alt="Screenshot 2022-10-27 at 12 09 26"
src="https://user-images.githubusercontent.com/13393018/198228440-3a7b52a6-9f33-4778-a2ab-15b1454ede99.png">

- TODO: Keyboard shortcut to trigger/focus the search modal. (Will
address this with a new PR)
2022-11-02 09:21:21 -05:00
373fde9ca2 Fix sidebar scroll and menu z-index (#587) 2022-09-29 15:04:21 -04:00
51da56df3c UI Enhancements: scroll, component naming, and more (#582)
- Fixed the sidebar scroll - with this fix, you'll be able to scroll to
the end of the left sidebar at any given screen height.
- Renamed content-navigation component and CSS class names for better
consistency.
- Changed the footer style by including it as part of the main content
area. This change is required to have the scroll fix mentioned at point
no. 1.
- Reduced the hero height by a small margin, in order to have more
sidebar scroll room on smaller devices such as 13 inch laptop and all.
- Used higher contrast color on search modal's bg and scrollbar thumb to
have better color consistency.
- Made scrollbar thumbs visible by default.
- Set sidebar scroll position to match the active doc item.
- Added custom scrollbars for code blocks.
2022-09-27 09:31:41 -05:00
c5a705d746 Fix doc menu and search being hidden on mobile (#579)
We might need to enable TOC on all pages to maintain the original mobile
menu design.
2022-09-23 15:51:49 -04:00
0b9a9effb2 Minor fix to filter results based on platform 2022-09-17 07:39:00 -07:00
5efcffbff1 Implement Algolia search (#553) 2022-09-16 13:46:52 -05:00
e3e22d332b Fix headerlink and update code styles (#559) 2022-09-15 14:50:49 -05:00
fc85a37c70 UI Enhancements: TOC depth and Table scrollbars (#542)
* Fix TOC depth

* Add custom scrollbars to tables
2022-09-06 11:44:56 -04:00
1bb0e097b7 Add responsive wrappers for tables (#533)
* Add responsive wrappers for tables

* Add missing styles
2022-08-23 14:49:05 -05:00
c6e1fc6124 Update theme as per the new design specs (#522) 2022-08-12 10:35:15 -05:00
ffeff0365e Migrate Tenant Deployment/management guides 2022-06-16 15:41:56 -04:00
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00
c84dcc74d4 Hide navigation links when loaded inside iframe 2022-03-28 08:50:53 -04:00
d602ed5b68 Update header and other related style properties 2022-01-31 14:12:55 -05:00
946c43785b SCSS fixups 2021-05-19 11:19:11 -04:00
d5d39def55 Update top navigation 2021-04-13 20:48:23 -04:00
36d811e7db move back to absolute url 2021-02-02 12:22:26 -08:00
1b8e574e7f add build support for npm 2021-02-02 11:51:40 -08:00
d4c82ff57c Fix sidebars and add responsive support 2021-01-25 17:26:58 -05:00
78108c0b40 New design implementation
Additional fixups
2021-01-14 19:40:19 -05:00
e3e9caf593 Alpha Release Work 2020-09-30 18:37:33 -04:00
d2657ec80a Additional CSS/JS FIxups 2020-09-21 19:33:11 -04:00
833931246f CSS and JS fixups
Trying a simplified layout + css + js
2020-09-21 12:55:21 -04:00
1c7ce6a9e2 Trying new page structure. See mc-admin-policy 2020-08-20 15:45:52 -04:00
aa832e1d2f Initial Commit (not yet MVP 1.0) 2020-08-14 18:35:26 -04:00