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
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#571Closes#614Closes#627Closes#633
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#636Closes#632
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
- 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.
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.
# 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.
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.
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.
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.
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
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
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.
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
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)
@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.
# 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.
- 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.
