1
0
mirror of https://github.com/minio/docs.git synced 2025-08-06 14:42:56 +03:00
Commit Graph

742 Commits

Author SHA1 Message Date
Javier Adriel
33d5c70922 Update installation.rst (#638) 2022-11-11 10:46:38 -05:00
Javier Adriel
6228d0f56e Fix typo in installation (#637)
Found this typo while reading the documentation. 
Not sure if this everything that is needed since i'm not familiar with
how docs are generated but hope this helps :)

Please close this PR if i'm missing something
2022-11-09 15:38:38 -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
Daryl White
46ef64ed2d Updates the Gateway migration doc (#631)
- Utilizes mc admin cluster commands to export/import bucket and IAM
settings.
- Adds export and import to the mc admin config command reference doc.
- Applies additional feedback from #628 that was added after that PR was
merged.
2022-11-04 16:05:07 -05: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
Daryl White
b5b345ae6f Add standalone migration procedure (#628)
Closes #624

Creates a new page under install-deploy-manage Operator docs. This page
summarizes the changes that led to the deprecation of the
Gateway/Filesystem. It overviews the steps required to create a new
Single-Node, Single-Drive deployment with the contents, settings, and
IAM policies from the old deployment.
2022-11-01 17:15:04 -05:00
Ravind Kumar
581de9f9ea Attempting to enable github rendering of markdown (#623)
# Summary

The default Markdown parser MyST provides doesn't seem to like the way
we've designed our SDK Markdown docs.

This change *should* enable github-strict parsing. It also adds
auto-headers to all H1s, which might resolve some of the TOC issues.

This gives us some breathing room to fixup the SDKs where we can still
allow for the files to look good in GitHub, but know they will render
properly on our Sphinx-built docs.
2022-11-01 12:02:29 -04: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
Ravind Kumar
f016fdb219 Additional fixes 2022-10-28 16:27:49 -04:00
Ravind Kumar
4385d06941 Improving tenant deployment guidance for PV/PVC 2022-10-28 16:27:49 -04:00
Ravind Kumar
af0fc05bc6 Minor fix to common-replication.rst 2022-10-28 16:27:01 -04:00
Ravind Kumar
4e4cc97f45 Major overhaul for Monitoring docs: Part 1 2022-10-28 16:27:01 -04:00
Daryl White
1735b77d8f Adding load balancing content for site replication (#622)
Closes #618

- Adds recommendation for pointing to a load balancer, reverse proxy, or similar for multi-node environments when creating aliases for site replication. 
- Explains that this recommendation avoids a single point of failure risk.
- Updates tabs on site replication page to be in sync when a reader selects Command Line or Console instructions.
- Adds :sync: option example to the design doc.
2022-10-27 13:10:02 -05: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
82c6d38278 Minor fixes 2022-10-20 17:57:16 -04:00
Daryl White
0aa9ee7e2b Add Multipart to Concepts and Glossary (#609)
Closes #595 

Applies multipart feedback in comments of PR #588.
2022-10-18 13:25:50 -05:00
Daryl White
b88a29a223 Update docs of mc release 2022-08-23 (#611)
Updates for mc release 2022-08-23
    
Closes #536

- Thoroughly updated the `mc ilm add` reference page and added --prefix and --newer** flags.
- Updates the `mc ilm edit` reference page to add the --prefix, --disable, and --enable flags.
- Adds `mc od` command
- Adds `--with-versioning` flag to `mc mb`
- Adds `--api-key` to `mc support diag`
- Adds clarification to --airgap flag on `mc license` and `mc support` topics that flag is not required if the local device has network access, even if the deployment is airgapped.
2022-10-18 13:22:33 -05:00
Ravind Kumar
21797d127b DOCS-610: Update KES procedures for KES 0.21.0, minor cleanups for Vault (#612)
Closes #610 

Did a QA pass after reports of some issues with the vault setup.

Identified an issue where my local testing was done with 0.20.0,
resulting in some errors on 0.21.0 due to dropping --mlock.

Also did a few other general tune ups as I ran end-to-ends again using
Vault + Systemd instead of vault in dev mode.

Staging views in #minio-docs channel
2022-10-18 13:15:05 -04:00
Daryl White
1963d67a64 Changes to get Algolia crawler to pull OpenShift docs (#613)
Algolia's crawler is not picking up the OpenShift docs.
This has fixes to get the sitemap to build correctly so the OpenShift
docs can be crawled.
2022-10-17 14:38:29 -05:00
Daryl White
bf471f3e8c Adds mc replicate diff command (#600)
Closes #599
mc replicate diff was missing. This adds it.
2022-10-12 11:21:36 -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
Daryl White
6e7444c812 Updates documentation for Console release 0.20.0 (#601)
Closes #535

- Updates MinIO Console doc section on the Support tab
- Adds info to several pages that Prometheus metrics displayed in the
console can now be downloaded
- Adds that bucket notification targets can now be deleted from the
console
- Updates the MinIO Console page to reflect the current navigation
layout by moving around sections and updating screenshots
2022-10-11 16:31:04 -05:00
Ravind Kumar
a8bf5a0037 DOCS-607: Fixing mc admin trace, minor syntax fix to glossary 2022-10-10 18:32:14 -04:00
Daryl White
d83b216a82 Adds information or requeueing healing processes (#598)
Closes #529

Release RELEASE.2022-08-11T04-37-28Z optimized when site healing
requeues.
Updated bucket replication and site replication docs to reflect this
change.
2022-10-05 12:57:46 -05:00
Harshavardhana
4e391920ba rename 'mc policy' -> 'mc anonymous' deprecated command (#597)
Co-authored-by: Ravind Kumar <ravind@min.io>
2022-10-04 15:13:37 -04:00
Ravind Kumar
f191fd7c10 Remove operator upgrade from TOC until procedure is written 2022-10-04 10:50:48 -04:00
Daryl White
c7a46b932f Updating docs for changes with Operator 0.19.5 (#592)
Closes #527

- Adds information about the new Register tab in the Operator
- Updates screenshots to show the Register tab
- Adds note about permissions when managing buckets in a tenant
- Added new FSGroupChangePolicy field to security context when creating
tenants
2022-10-03 16:41:21 -05:00
Daryl White
201b13324e Mc issues (#588)
Addresses five outstanding Issues in the `mc` reference docs.

- Adds `--disable-multipart` flag for `mc mv` (Closes #516 )
- Adds `mc pipe` to reference docs (Closes #517 )
- Adds `mc undo` to reference docs (Closes #520 )
- Adds `mc support top` commands to replace `mc admin top` (Closes #526)
- Updates `mc cp`, `mc mirror`, `mc replicate`, and `mc admin replicate`
to clarify the differences in what copies (Closes #532)
2022-10-03 14:45:56 -05:00
Harshavardhana
59760ed079 download rpm as minio.rpm not minio.deb (#594) 2022-10-03 13:44:11 -04:00
Rushan
8f0790e66b Add Leadfeeder tracking code (#593) 2022-10-03 09:52:21 -05:00
Ravind Kumar
d5d3243413 DOCS-580: Fixing reported issues with Vault tutorial (#591)
@djwfyi cursory review in case I missed something.

Closes #580 

I do need to do further testing beyond the patches here. But I'm going
to handle that out-of-band.
2022-09-30 17:47:12 -04:00
Anthony CISZEK
ce1a843a62 Update setup-nginx-proxy-with-minio.md (#589)
Fix typo in nginx config file path:

/etc/nginx/sites-enable**s**/minio instead of enabled.
2022-09-30 11:13:45 -04:00
Rushan
373fde9ca2 Fix sidebar scroll and menu z-index (#587) 2022-09-29 15:04:21 -04:00
Ravind Kumar
c3a1e501d9 Fixing CSS issue 2022-09-29 10:50:17 -04:00
Ravind Kumar
32366b2a15 Adding OpenShift Platform (#577)
# Summary

This pull adds back the OpenShift docs as a full dedicated platform

The main changes are:

- Adding the conditionals for OpenShift
- Modifying the Makefile for the new platform
- Adding the tutorials back in
- Fixing up the navigation headers

This was not too much trouble, which bodes well for the future.
2022-09-29 10:37:08 -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
Daryl White
92ee087d4f Updating all references to docs.min.io URLs (#584)
Updating remaining links to the old docs site to point to the new URLs.

Closes #581
2022-09-26 14:21:29 -05:00
Rushan
8b05179910 Add Linkedin insights (#583) 2022-09-26 13:46:46 -04:00
Ravind Kumar
33af30eb71 Fix typo in container quickstart 2022-09-23 16:11:48 -04: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
Daryl White
5a6a298132 Adds file to list steps needed after adding a new platform (#578)
General cleanups I've noticed after new docs launched.

- Creates a markdown doc for steps needed after creating a new platform
for the doc site.
- Adds min.io sitemap to the sitemap_index file.
- Fixes two links causing some crawler errors in glossary and
troubleshooting files.
2022-09-22 13:52:39 -05:00
Ravind Kumar
019ccb9e80 General cleanups for driver synchronization (#572)
A few minor cleanups:

- Removing the SDK markdown docs from git tracking. They're already
tracked in the SDK directories, we don't need to do that twice
- Cleaning up the builds, as only Linux needs to build out the SDK docs
at this time
- Fixing build-docs.sh to build the SDK docs with Linux (so we get
proper version numbers). Means we have to build Linux with SYNC_SDK=TRUE
on the server to pull in the SDK docs (otherwise they will all be
empty).


Tested locally and everything seems to work just fine. Will see what
happens when it goes live, but I figured I'd ask for @harshavardhana 's
thoughts since they know more about the build server script process than
I do.
2022-09-21 15:27:05 -04:00
Harshavardhana
7388f4b33e update mc/minio source installation docs (#575) 2022-09-21 13:40:06 -04:00
Ravind Kumar
6501f7abd1 Fixing conditional for K8s operator version 2022-09-20 12:53:35 -04:00
Ravind Kumar
c973797fa0 Synchronizing SDK content 2022-09-20 12:42:51 -04:00
Ravind Kumar
2344cb304e Cleaning up build errors 2022-09-20 12:35:05 -04:00
Ravind Kumar
b099ffb149 Removing redundant licensing section 2022-09-20 12:33:06 -04:00
Ravind Kumar
1cc507564c Initial work for git-managed redirects (#556)
This is the initial work for what should be a git-managed set of nginx
configs we can include into the Nginx Docs server.

The idea here is we manage redirects in git, and either chron-copy them
to a location we can include via the sites-available/<file>, *or* we
just include them from the git path (if nginx tolerates that)

I can't really _test_ these right now since they are using live URLs. if
we move forward with the soft-launch, we'll have a few opportunities to
maybe test a subset of these URLs and see what happens.

Please let me know if there is anything *obviously* wrong here.

ToDo: The Legacy Docs redirects
2022-09-20 12:27:40 -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