minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-04-21 08:05:59 +03:00
Code
594 Commits 18 Branches 0 Tags
Commit Graph

60 Commits

Author SHA1 Message Date
Rushan
bb03238c77
Add default background color for images (#1063) 
**Issue**:
<img width="793" alt="Screenshot 2023-11-07 at 11 53 29"
src="https://github.com/minio/docs/assets/13393018/2832944a-74a5-4e24-968d-1a3069812c2b">

**Fix**:
<img width="793" alt="Screenshot 2023-11-07 at 11 53 20"
src="https://github.com/minio/docs/assets/13393018/69305855-d384-4f58-8a1c-a6f3d3dfbebe">
 2023-11-07 18:35:41 -05:00
Ravind Kumar
69e291fa6e
DOCS-1007: Create sync pattern to pull in the CRD during releases (#1025) 
Closes #1007
 2023-10-10 16:45:06 -04:00
Rushan
d68d9bc774
Increase code readability in dark mode by updating the syntax theme (#1004) 2023-09-18 11:25:00 -04:00
Rushan
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
Rushan
76099f5cda
Style Quick Steps section on quickstart pages (#977) 
The section can be styled by adding the container class `.. rst-class::
section-next-steps`


<img width="798" alt="Screenshot 2023-08-30 at 13 52 07"
src="https://github.com/minio/docs/assets/13393018/7ff22195-1d2a-454f-9736-ea89a58a7515">
 2023-08-30 10:59:19 -05:00
Rushan
dc2b67c449
Increase the font size of card content (#899) 
Fixes https://github.com/minio/docs/issues/869
 2023-06-27 15:23:54 -05:00
Rushan
edbbe90742
Add docs switch menu (#881) 
Fixes https://github.com/minio/docs/issues/842

Also made some changes to the dark-mode/read-mode icons to maintain the
consistency with KES docs UI.

**Preview:**
<img width="627" alt="Screenshot 2023-06-15 at 14 19 32"
src="https://github.com/minio/docs/assets/13393018/708d8991-c6af-406f-a474-65449c38c06c">

<img width="627" alt="Screenshot 2023-06-15 at 14 19 36"
src="https://github.com/minio/docs/assets/13393018/63f9db43-1408-4e96-81ad-9ecb7c39b9f0">


**Updating the list:**

Edit the `docs` array in `default.conf.py@268`.
 2023-06-16 14:36:35 +04:00
Rushan
423e38315e
Fix admonition toggle button padding (#858) 
Fixes https://github.com/minio/docs/issues/857
 2023-05-18 10:03:22 -05:00
Ravind Kumar
b3fdcef007
DOCS-763: Update pool, availability, resiliency, and erasure code docs (#843) 2023-05-12 12:19:45 -04:00
Ravind Kumar
3f6b8ea57d
DOCS-780: Bug Stomping (#844) 
A few big things here:

- Updated to Sphinx 6.2.1 successfully. I'm using Python 3.10.10
- Upgraded to docutils 0.19, which is latest
- Upgrade myst-parser and sphinx-design to latest stable
- Fixed a bunch of warning outputs
 2023-05-11 16:57:03 -04:00
Rushan
6c6a1d49db
Increase left nav width (#839) 2023-05-01 16:50:03 -05:00
Rushan
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
Rushan
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
Kaan Kabalak
9f2d66f1c5
Display ToC text enclosed in code tags (#713) 
This commit also removes links located on certain subtitles

Fixes #703
 2023-01-25 12:12:19 -05:00
Rushan
376f37f69e
Add search page (#687) 
- Default Sphinx search page has been replaced with Algolia's 
- Enabled routing to sync the search results with URL

**Preview:**
<img width="1458" alt="Screenshot 2022-12-30 at 14 47 28"
src="https://user-images.githubusercontent.com/13393018/210061993-c906461e-87e2-426f-b956-462cfa77ed40.png">

**How to test:**
1. Click on a search result, navigate back using the browser back button
and check whether the search result modal is open and available.
2. Type a search keyword and press the enter key to navigate to the
search results page, where you can find all the results listed.

Note: You might need to start the local web server on the exact build
sub-directory to test the point number 2.
`build/[branch]/[platform]/html/` - ✔️
`build/` - ❌
 2022-12-30 12:42:11 -06:00
Ravind Kumar
094d0df6b8
Proof of Concept on right-nav video links via RST + JS (#682) 2022-12-27 13:46:55 -05:00
Rushan
d3e40ff232
Fix anchor scrolling issue on Webkit browsers (#669) 2022-12-08 12:40:54 -06:00
Rushan
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
Rushan
ceefee34fe
Search UX enhancements (#629) 
- Fix the visibility of search popup on read-mode (Prakash's comment)
- Add keyboard shortcut indicator on the read-mode search icon
<img width="254" alt="Screenshot 2022-11-04 at 17 39 05"
src="https://user-images.githubusercontent.com/13393018/199986826-e5e4ffe7-218f-4850-a0bf-867c1beb08b7.png">
 2022-11-07 11:00:28 -06:00
Rushan
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
Ravind Kumar
64ca9697cf
DOCS-625: Removing FS Mode guidance, cleanups to deploy docs (#626) 
Closes #625
 2022-10-31 14:21:44 -04:00
Daryl White
e306783abc
Update guilabel style; fixes for build errors (#616) 
Applies style changes to the `.guilabel` css class to better set off the
labels in the docs:

- Adds a pill box effect
- bolds the text
- Applies the `--theme-light-bg` color variable to the background

Corrections for build errors

- `mc ilm add` changed `storage-class` flags to `tier` instead. Updated
several pages with references to those flags.
- Corrects a bad reference in the `mc license info` doc to the minio
client page that was missing a hyphen.
 2022-10-26 12:17:13 -05:00
Ravind Kumar
8d8e6bca29
Procedure for updating Operator (#608) 
Build out Operator Upgrade Procedure

Co-authored-by: Lenin Alevski <alevsk.8772@gmail.com>
 2022-10-12 12:08:30 -04:00
Rushan
373fde9ca2
Fix sidebar scroll and menu z-index (#587) 2022-09-29 15:04:21 -04:00
Rushan
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
Rushan
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
Rushan
bb39d1139e
Fix active nav link (#566) 
**Issue:**
<img width="684" alt="Screenshot 2022-09-20 at 11 57 22"
src="https://user-images.githubusercontent.com/13393018/191200923-0db07127-05ab-4251-a56f-7207619796e0.png">

**Fix:**
<img width="684" alt="Screenshot 2022-09-20 at 11 57 26"
src="https://user-images.githubusercontent.com/13393018/191201017-381b0060-4aed-4d1c-ae58-b2f911878cdc.png">
 2022-09-20 09:02:13 -05:00
Kaan Kabalak
4162b52a65
Fix incorrect font being displayed on docs (#567) 
Sans-serif font was being displayed on docs instead of Inter due to a
font definition issue
 2022-09-20 14:46:51 +04:00
Rushan
735b6be2ce
UI enhancements: Search modal, scrollbars and permalink text (#564) 
- Fix search source title background overlap.
- Remove default permalink text. (This'll remove the pilcrow sign
displayed after each search result).
- Enhance search modal's scrollbar colors.
 2022-09-19 15:00:53 -05:00
Rushan
5efcffbff1
Implement Algolia search (#553) 2022-09-16 13:46:52 -05:00
Rushan
e3e22d332b
Fix headerlink and update code styles (#559) 2022-09-15 14:50:49 -05:00
Rushan
6d97161b87
Update font and related changes (#549) 2022-09-09 10:45:22 -04:00
Rushan
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
Rushan
1bb0e097b7
Add responsive wrappers for tables (#533) 
* Add responsive wrappers for tables

* Add missing styles
 2022-08-23 14:49:05 -05:00
Rushan
01a5552631
Update syntax highlight color (#534) 2022-08-23 11:02:14 -04:00
Rushan
dc454d7246
UI enhancements: Nav active state, Copy button UI and Text colors (#524) 
* Update footer text color

* Add hover color for nav links

* Update the copy button UI

* Add active class on content nav based on platform
 2022-08-15 13:11:36 -04:00
Rushan
c6e1fc6124
Update theme as per the new design specs (#522) 2022-08-12 10:35:15 -05:00
Daryl White
9f6086fdc6 Adding a glossary file and updating term link color 
This commit only adds the glossary to the docs.
It does not apply :term: directives throughout the rest of the docs to link to the glossary.
 2022-07-13 13:23:28 -05:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00
Ravind Kumar
a566631be2 DOCS-448: Create new per-platform quickstart guides 
Co-authored by: Ravind Kumar <ravind@min.io>
Co-authored by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2022-04-20 10:03:20 -05:00
Rushan
c84dcc74d4 Hide navigation links when loaded inside iframe 2022-03-28 08:50:53 -04:00
Ravind Kumar
175b912456 Additional fixups 2022-02-16 10:32:10 -05:00
Ravind Kumar
b15493e2f9 Update to sphinx 4 2022-02-16 10:32:10 -05:00
Kaan Kabalak
9b4824970a Keep same font size for every element in table 
Fixes #419
 2022-02-07 19:45:53 -05:00
Rushan
d602ed5b68 Update header and other related style properties 2022-01-31 14:12:55 -05:00
ravindk89
dc15653e38 DOCS-376: Integrate Sphinx Design, remove sphinx-tabs 2021-09-09 12:46:37 -04:00
ravindk89
4d67368d3d Fixing right sidebar 2021-08-06 13:44:24 -04:00
ravindk89
73772c7f84 Additional css fix 2021-08-02 12:51:52 -04:00
Rushan
1fad32d538 Re-align layout and make sidebar toggle visible by default 2021-08-02 08:48:40 -04:00
ravindk89
221285a64d Cleaning CSS, updating packages 2021-07-29 17:09:01 -04:00