1
0
mirror of https://github.com/minio/docs.git synced 2025-06-11 16:28:19 +03:00
Commit Graph

324 Commits

Author SHA1 Message Date
0c4c7be68b BUGFIX: PostgreSQL and MySQL Bucket Notification Examples have incorrect values 2022-11-23 09:56:44 -05:00
0a68ca4ff9 Adding bucket limit information (#649)
- Imports the limits doc from legacy into the Checklists section
- Adds 500K limit to buckets in several places

Closes #548
2022-11-22 15:25:44 -06:00
bce5f8267f Updates for minio RELEASE.2022-08-22T23-53-06Z (#648)
Doc updates related to for minio RELEASE.2022-08-22T23-53-06Z
    
- Adds note about idempotent delete markers, which diverges from
standard S3
- Adds info about queueing and re-attempting failed bucket replication
tasks
- Cleans up `mc ilm add` examples throughout the docs that did not
reflect recent flag name changes
- Adds a missing metric to Metrics and Alerts

Closes #537
2022-11-22 15:08:35 -06:00
0cd491c328 Mc updates for multiple releases (#642)
Updates `mc` reference docs for several releases of the MinIO Client.

- Adds missing flags to `mc admin trace`
- Updates `disk` -> `drive` throughout the docs, but not in all cases.
- Adds `--airgap flag` to `mc support profile` and `mc support perf`
commands.
- Updates the flags for `mc ilm add` command
- Adds `mc license unregister` command.
    
Closes #571
Closes #614
Closes #627
Closes #633
2022-11-18 12:49:03 -06:00
2f8c5a94f6 Release updates mc RELEASE.2022-11-07T23-47-39Z (#640)
Changes to the docs related to mc
[RELEASE.2022-11-07T23-47-39Z](https://github.com/minio/mc/releases/tag/RELEASE.2022-11-07T23-47-39Z)

- Replaces `mc replicate edit` with `mc replicate update`
- Adds `mc admin idp oidc | ldap` commands
- Update to `mc support inspect` format
- Adds `mc admin rebalance` command
- Updates mc replicate edit references throughout docs to point to mc
replicate update.
- Adds a rebalance pools section to the expand deployment doc.
- Clarifies precedence for environment variables vs config settings.

Closes #636
Closes #632
2022-11-18 12:31:11 -06:00
422d0d915f Update docs for mc release 2022-10-01 (#643)
Closes #602

- Revises the note about mc support commands requiring SUBNET
registration
- Moves note to the top of each `mc support` subcommand page
2022-11-16 16:03:57 -06:00
c2cffd0023 Fix: Cleaning up language on bucket replication for consistency 2022-11-16 11:21:54 -05:00
0e3ca880ca Corrects missing part of alias set command (#641)
Fixes a missing part of the `mc alias set` command and adds formatting
to the `PATH` in the replacement list for the command.
2022-11-15 09:42:39 -06:00
e2f30fb5fd Adds mc batch commands to the docs (#620)
Closes #605

- Adds the five `mc batch` subcommands
- Adds a batch framework page to the Administration section of docs
2022-11-14 17:40:21 -06:00
33d5c70922 Update installation.rst (#638) 2022-11-11 10:46:38 -05:00
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
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
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
1244a27e66 Attempting fix to build script 2022-11-02 13:18:56 -04: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
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
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
64ca9697cf DOCS-625: Removing FS Mode guidance, cleanups to deploy docs (#626)
Closes #625
2022-10-31 14:21:44 -04:00
f016fdb219 Additional fixes 2022-10-28 16:27:49 -04:00
4385d06941 Improving tenant deployment guidance for PV/PVC 2022-10-28 16:27:49 -04:00
af0fc05bc6 Minor fix to common-replication.rst 2022-10-28 16:27:01 -04:00
4e4cc97f45 Major overhaul for Monitoring docs: Part 1 2022-10-28 16:27:01 -04:00
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
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
82c6d38278 Minor fixes 2022-10-20 17:57:16 -04:00
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
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
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
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
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
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
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
a8bf5a0037 DOCS-607: Fixing mc admin trace, minor syntax fix to glossary 2022-10-10 18:32:14 -04:00
90829c962c apply license file properly (#603) 2022-10-07 13:43:12 -04:00
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
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
f191fd7c10 Remove operator upgrade from TOC until procedure is written 2022-10-04 10:50:48 -04:00
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
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
59760ed079 download rpm as minio.rpm not minio.deb (#594) 2022-10-03 13:44:11 -04:00
8f0790e66b Add Leadfeeder tracking code (#593) 2022-10-03 09:52:21 -05:00
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
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
373fde9ca2 Fix sidebar scroll and menu z-index (#587) 2022-09-29 15:04:21 -04:00
c3a1e501d9 Fixing CSS issue 2022-09-29 10:50:17 -04:00
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
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
aaa74a8ee7 cleanup SDK sync and reduce makefile burden (#585) 2022-09-26 15:52:15 -05:00
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
8b05179910 Add Linkedin insights (#583) 2022-09-26 13:46:46 -04:00