Commit Graph

46 Commits

Author SHA1 Message Date
Billy Tat 2b36bf35c1 Fix indentation: causing triple backtick to render in codeblock 2024-09-20 15:48:20 -07:00
Marty Hernandez Avedon c869ea69ac Fix order of headings (#1465)
* Fix 'title out of sequence' errors

fixed Dockershim.md

* fixed deprecated-features.md

* fixed install-and-configure-kubectl.md

* fixed rancher-is-no-longer-needed.md

* fixed security.md

* fixed technical-items.md + spacing, duplicate section, admonitions

* fixed telemetry.md

* fixed upgrades.md

* fixed upgrade-kubernetes-without-upgrading-rancher.md

* fixed air-gapped-upgrades.md

* fixed dockershim.md

* fixed docker-install-commands.md

* fixed install-kubernetes.md

* fixed infrastructure-private-registry.md

* fixed install-rancher-ha

* fixed manage-namespaces and tune-etcd-for-large-installs.md

* fixed cis-scans/configuration-reference.md

* fixed custom-benchmark.md

* fixed supportconfig.md

* fixed harvester/overview.md

* fixed logging-architecture.md

* fixed logging-helm-chart-options.md + rm'd unnecessary annotation title

* fixed taints-and-tolerances.md

* fixed longhorn/overview.md

* fixed neuvector/overview.md

* fixed monitoring-and-alerting

* fixed rancher-cli.md

* fixed cluster-configuration.md

* fixed monitoring-v2-configuration/examples.md

* fixed servicemonitors-and-podmonitors.md

* fixed other-troubleshooting-tips/dns.md
2024-09-18 14:02:55 -04:00
Billy Tat 2458b04c66 Merge pull request #1383 from btat/typo
Fix Tabs groupId typo + other typos
2024-07-15 17:15:57 -07:00
Billy Tat 822f8f4974 Fix Tabs groupId typo + other typos 2024-07-15 14:33:43 -07:00
Sunil Singh d754e9d5ee Note - Generating Kiali Session Token (#1366)
* Adding note on generating session token and the service account name expected.

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* Updating after review and researching Kiali docs. Added link to Kiali docs and Kiali token authentication strategy page.

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* Updating link with better example

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* Updating the Istio - Generate and View Traffic from Istio page to include text guiding users on token generation for Kiali login. This commit has strictly structural changes to the page.

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* Removing repetitive intro line.

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* Updating note across versions to include information on Istio auth strategy and adding text into Generate and View Traffic - Prereq section regarding auth strategy and the service account name to specify during token generation.

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* Applying review suggestions.

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* Fixing header to h2 and rephrasing optional text after review.

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

---------

Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-07-11 13:04:26 -04:00
Marty Hernandez Avedon 305729a434 #1358 Link to 'Settings for etcd tuning' no longer valid, plus other fixes to links to etcd.io/docs (#1362)
* 1358 Link to 'Settings for etcd tuning' no longer valid

updates dead link to new URL

* updated etcd version links

2.0-2.4 was tricky, I opted for etcd v3.3 as it's identical to the text on v3.4 except for a single clarifying heading

* update link in v2.5 to etcd v3.3 to cover downstream

* other 3.4 files in /docs

* other 3.4 files in /v2.9

* other 3.4 files in /v2.8

* other 3.4 files in /v2.7

* other 3.4 files in /v2.6

* other 3.4 files in /v2.5

* other 3.4 files in /v2.0-2.4

* rm'ing '.0' from URLs

* update v2.6 links to account for differing etcd versions

* chinese links
2024-07-10 14:42:31 -04:00
Billy Tat 5a7b194c65 Merge pull request #1346 from btat/zh-pr1223-sync
[zh] Sync with PR #1223 "Remove multi-cluster apps references"
2024-06-18 15:07:13 -07:00
Marty Hernandez Avedon bab236b0a2 User Retention Feature for Security Release (#1343)
* SURE-8285 Document user retention feature

* fixing changes for global-configuration.md

* versioning plus the enable user authentication page

* Apply suggestions from code review

Co-authored-by: Andy Pitcher <andy.pitcher@suse.com>
Co-authored-by: Peter Matseykanets <peterm@mail.ru>
Co-authored-by: pdellamore <pietro.dellamore@suse.com>

* versioning, updates to descriptions of settings

* correcting versioning & rm v2.9 file

* one more correction

* if you can't remove the file, just make sure it's synced...

* Update docs/how-to-guides/advanced-user-guides/enable-user-retention.md

Co-authored-by: Peter Matseykanets <peterm@mail.ru>

* user-last-login-default

* more settings, more details about deletion behavior

* versioning

* more explanation for last-login

* revising blurb about disabling

* describing deletion behavior less direly

* corrected commands

* fix overwrite

* corrected commands

* updated description of zero value

* sidebars

* canonical link fixed

* rm'd parenthetical versioning remark

* heading capitalization, log in vs login

* more log in

* revise command, important box, enabling user retention section

* clarifying that some optional settings are also global

* rm patch mention from 2.9

* explain how to view settings for individual users

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

* duplicate word rm'd

---------

Co-authored-by: Andy Pitcher <andy.pitcher@suse.com>
Co-authored-by: Peter Matseykanets <peterm@mail.ru>
Co-authored-by: pdellamore <pietro.dellamore@suse.com>
Co-authored-by: Billy Tat <btat@suse.com>
2024-06-17 18:09:40 -04:00
Billy Tat f7f742b066 [zh-2.7] Sync with PR#1223 Remove multi-cluster apps references 2024-06-17 13:53:42 -07:00
Dan Pock d99dc0ac98 sync table to match on all docs versions 2024-06-04 08:47:41 -04:00
Billy Tat 7245df6e2b Merge pull request #1300 from btat/cattle-prometheus-metrics
Document performance dashboard
2024-05-23 11:52:27 -07:00
Billy Tat a23e5823b5 Update versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring.md
Co-authored-by: Silvio Moioli <moio@suse.com>
2024-05-23 10:14:32 -07:00
Billy Tat cfd8e386d0 Apply suggestions from code review
Co-authored-by: Silvio Moioli <moio@suse.com>
2024-05-23 09:47:28 -07:00
Billy Tat dbd40f2324 Fix dashboard labels 2024-05-22 09:20:03 -07:00
Billy Tat 509532c9bb Document performance dashboard 2024-05-21 16:22:04 -07:00
Marty Hernandez Avedon d4796a1ae8 #999 Clarify support and stipulations for use of firewall in documentation (#1292)
* 999 Clarify support and stipulations for use of firewall in documentation

added scarier warning about firewalld usage

* revised language slightly

* Update docs/how-to-guides/advanced-user-guides/open-ports-with-firewalld.md

Co-authored-by: Sunil Singh <sunil.singh@suse.com>

* versioning, updated link, & abbreviated warning for v2.0-2.4

---------

Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2024-05-21 11:42:33 -04:00
Marty Hernandez Avedon 6ccd0b7b6c Syncing sidebar with page titles and disambiguating brief titles (#1197)
* Syncing sidebar labels with page titles

Deploying Rancher Server: Update sidebar label to match title

* Installing/Upgrading Rancher: Update title to match sidebar

This is a reference/hub page for install guides with no step-by-step instructions, so we're breaking the -ing rule to match other reference pages as well as the current sidebar label

* Cluster Access: Update title to match sidebar

* Kubernetes Persistent Storage: Volumes and Storage Classes - Update title to match sidebar

* Don't have a Kubernetes cluster? Try one of these tutorials: Update title to match sidebar and make old title intro to page

* Don't have infrastructure for your Kubernetes cluster? Try one of these tutorials: Update title to match sidebar and make old title intro to page

* versioning Deploying Rancher Server update to other sidebars

* Setting Up Kubernetes Clusters in Rancher: Update sidebars to match title and other sidebar labels

* capitalization

* Creating a vSphere Cluster: Update sidebar to match title and other labels

* Creating a Nutanix AOS Cluster: Update sidebar to match title and other labels

* Kubernetes Clusters in Rancher Setup across the board for title and sidebar, to match convention in sidebar

* Kubernetes Resources: Updated title to match sidebar and distinguish from identically-titled page in troubleshooting section

* The Horizontal Pod Autoscaler: Updated title to match sidebar

* Backups and Disaster Recovery: Update title to match sidebar

* typo fix

* revert to Installation and Upgrade of Rancher

fix typo in title: Create Kubernetes Persistent files

* fix typo in Persistent Storage files

* Configuration: Update title to match sidebar item Monitoring V2 Configuration Guides

* Setup Guide: Make both sidebar + title Istio Setup guides to match other sidebar labels

* Best Practices: Update both to Best Practice Guides

* Architecture: Update to match sidebar Rancher Architecture.

Note that there are multiple pages with identical titles, one is on Fleet and another on some other subject

* Architecture: Retitle logging-architecture.md files Logging Architecture

* Architecture: Retitle fleet/architecture.md files Fleet Architecture

* GKE Cluster Configuration: Update sidebar to match title and other labels in same section

* Security: Update both to Rancher Security Guides

* RKE Hardening Guide: Update to match sidebar

* typo

* RKE2 Hardening Guide: Update to match sidebar

* K3s Hardening Guide: Update to match sidebar

* various FAQ pages: Add FAQ to title to disambiguate content

* Cloud Native Storage with Longhorn: Versioning so older pages match current title

* rm international pages for now

* typo in metadata killed build

* updated sidebar: plural Istio Setup Guides

* updating Monitoring Config Guides title/label and distinguishing from similar section under References

* monitoring V2 config examples: rm 'V2'

* Kubernetes Cluster Setup > Setting up a Kubernetes Cluster for Rancher Server
2024-04-09 17:10:29 -04:00
Billy Tat 2105fc4c23 Apply suggestions from code review
Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2024-04-09 09:11:04 -07:00
Billy Tat 2fa977d4a3 Fix Fleet integration page/URL 2024-04-08 19:03:36 -07:00
Billy Tat 6c24fdb4f7 Replace links to deploy-across-clusters/fleet.md 2024-04-08 18:42:40 -07:00
Marty Hernandez Avedon c5bd3a9126 #990 create persistent grafana dashboard missing steps for creating in UI (#1026)
* rm deprecation banner from v2.8

* 990 create-persistent-grafana-dashboard missing steps for creating in UI

* added value plus note about modified helm chart

* 'note that' > :::note

* slight reword

* versioning

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

---------

Co-authored-by: Billy Tat <btat@suse.com>
2024-02-07 17:14:05 -05:00
Billy Tat dae1b76dc6 Update canonical links 2024-01-29 10:07:22 -08:00
Billy Tat 59bd6ba5e7 Merge remote-tracking branch 'upstream/main' into move-pages-for-subheaders-2.7 2024-01-19 13:56:11 -08:00
Marty Hernandez Avedon 2302e37376 #753 other title improvements (#1050)
* vagrant quickstart retitled for consistency

* rm number from title

* 2. rm number from title

* 3. rm number from title (Istio related, as were 2 prev)

* 4. rm number from title (Istio related)

* 5. rm number from title (Istio related)

* 6. rm number from title (Istio related)

* making backup 'examples' title more specific

* rewrite + making monitoring 'examples' title more specific

* suggestions from Btat

correcting capitalization for github, combining two lines into one

* versioning previous commit

* applying sunil's suggestions

rm'ing numbers from titles of pages missed in 2.0-2.4

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

---------

Co-authored-by: Billy Tat <btat@suse.com>
2024-01-17 13:30:50 -05:00
Billy Tat e0dc5a7bc4 [2.7] Move files out of pages-for-subheaders 2024-01-11 14:22:42 -08:00
Marty Hernandez Avedon 3a4b7e73c0 #766 Consistently using verbs in titles (#1038)
* gerundify Configuration for Storage Classes in Azure

* gerundify Authentication Config

* gerundify Bootstrap Password

* gerundify and disambiguate manage-PSP

* gerundify and disambiguate create-PSP

* syncing? Syncing what?

* updating label for Configure OpenLDAP

* updating label for authentication config

* updating label for configuring microsoft ad and shibboleth (saml)

* updating label for configuring microsoft ad and shibboleth (saml) in sidebars (last commit covered versioned docs)

* label + title for one of several sets of pages entitled role-based access control

* gerundify Upgrade a Hardened Custom/Imported Cluster to Kubernetes v1.25

* re-order title of Certificate Troubleshooting so verb comes first

* added 'about' to title because the page is about drivers that provision, not how to provision a driver

* template enforcement > enforcing templates

* update label to match title - deploy > deploying

* updated label to matach title - manage clusters > cluster administration

* gerundify set up in infrastructure setup section

* typo fix - spacing

* matching label to title - launch > launching

* label matching title - set up part 2

* label matching title - windows clusters

* how to configure > configuring

* using > launching (partially matches label to title)

* ingress config > configging an ingress

* match label to title - project administration

* match label to title - project resource quotas

* match title to label - monitoring/alerting guides

* matching label to title - enabling

* gerundify allow unsupported storage drivers

* Update openapi/swagger.json

* lost metadata syntax re-applied

* Apply suggestions from code review
2024-01-11 12:49:32 -05:00
Billy Tat 51ed6e977b Convert 'broken' links to standard Markdown links 2024-01-08 16:30:27 -08:00
Marty Hernandez Avedon e479cc33e3 rm 'add additional' phrase from docs (#1020)
* rm 'add additional' phrase from docs

* these > more
2023-12-06 18:35:48 -05:00
Jiaqi Luo f79994a08d add a new method for enabling the API audit log in RKE2 downstream clusters (#900) 2023-10-13 14:46:58 -07:00
Silvio Moioli 5904c88eff revision of hardware/scale requirements and best practices: port changes to 2.7
Signed-off-by: Silvio Moioli <silvio@moioli.net>
2023-10-06 10:29:17 +02:00
Jiaqi Luo bcfd5b25aa Add the instruction for enable API audit log in downstream clusters (#824) 2023-09-13 16:05:50 -07:00
Marty Hernandez Avedon 039fa9c1db Convert links to https://rancher.com/docs/rancher/v2.6 to use correct Markdown syntax (#830) 2023-09-07 21:03:12 -04:00
Tejeev 02912f266c clarified location of project ID field (#823)
* clarified location of project  ID field

* v2.7 page sync

---------

Co-authored-by: martyav <marty.avedon@suse.com>
2023-09-06 17:49:29 -04:00
Marty Hernandez Avedon 36f84327ea canonicized advanced user guides (#813) 2023-08-25 15:57:47 -04:00
Marty Hernandez Avedon bea15afa17 canonicized cis-scan-guides (#812) 2023-08-25 14:35:52 -04:00
Marty Hernandez Avedon 1e4d576296 canonicized istio-setup-guide (#811) 2023-08-25 14:34:43 -04:00
Marty Hernandez Avedon f7557d8e99 #420 - Canonical links for manage-projects (#810)
* canonicized manage-project-resource-quotas

* canonicized manage-projects
2023-08-25 14:07:44 -04:00
Marty Hernandez Avedon cc1b56c892 canonicized monitoring-alerting-guides (#804) 2023-08-23 17:18:43 -04:00
Marty Hernandez Avedon 411825bbdc #755 Update CIS Benchmark note (#791)
* #755 Update CIS Benchmark note

* Update docs/how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark.md

Co-authored-by: Billy Tat <btat@suse.com>

* syncing version-2.7

---------

Co-authored-by: Billy Tat <btat@suse.com>
2023-08-22 16:55:33 -04:00
Marty Hernandez Avedon d9bf7f41a5 canonicized prometheus-federator-guides (#800) 2023-08-22 16:55:09 -04:00
Marty Hernandez Avedon 95b8aa9530 canonicized monitoring-v2-configuration-guides (#799) 2023-08-22 15:59:23 -04:00
Billy Tat 5bf27acc72 Apply suggestions from code review
Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2023-07-18 13:20:35 -07:00
Billy Tat 90851156f9 Remove references to old versions 2023-07-17 16:32:00 -07:00
vickyhella b6149deeac Fix broken links in EN docs 2023-06-15 18:22:14 +08:00
Billy Tat e329d0fab6 Apply 9f65c72d..ae741d3b to version-2.7 docs 2023-06-06 16:00:23 -07:00
Billy Tat 754bfdcab5 Add version-2.7 docs 2023-06-06 16:00:23 -07:00