Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: DOC-912: Add Maintenance Mode Documentation #5100

Merged
merged 18 commits into from
Jan 8, 2025
Merged

Conversation

achuribooks
Copy link
Contributor

@achuribooks achuribooks commented Dec 18, 2024

Describe the Change

This PR fills a documentation hole pertaining to maintenance mode, which was implemented in 4.0 but never documented outside of release notes. Existing release notes are also misleading, as maintenance mode also works on non-VMO clusters.

PR 5193 fixes the release note. Merge it ONLY AFTER this PR (5100) is complete.

Changed Pages

💻

Jira Tickets

🎫 DOC-912

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

@achuribooks achuribooks added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 backport-version-4-5 Backport changes to the version-4-5 branch. labels Dec 18, 2024
Copy link

netlify bot commented Dec 18, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit f748150
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/677ed08e72149b0008254203
😎 Deploy Preview https://deploy-preview-5100--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 3.7%, saving 3.76 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/clusters_cluster-management_maintenance_mode.webp 102.49 KB 98.73 KB -3.7% View diff

785 images did not require optimisation.

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 1.3%, saving 1.24 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/clusters_cluster-management_maintenance_mode.webp 98.73 KB 97.48 KB -1.3% View diff

785 images did not require optimisation.

Copy link
Contributor

@caroldelwing caroldelwing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with tiny suggestions. Well done 👏

@achuribooks achuribooks enabled auto-merge (squash) January 8, 2025 19:23
@achuribooks achuribooks merged commit 4844027 into master Jan 8, 2025
15 of 17 checks passed
@achuribooks achuribooks deleted the DOC-912 branch January 8, 2025 19:24
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jan 8, 2025
* Initial commit for Maintenance Mode documentation

* Webp image conversion

* Minor updates

* Added procedure and validation to Disable Maintenance Mode section

* Minor cleanup; additional x-refs; affirmation that scans are intentionally disabled

* ci: auto-formatting prettier issues

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Minor style guide and spelling fixes

* ci: auto-formatting prettier issues

* Fixed spacing caused by merge conflict

* ci: auto-formatting prettier issues

* Spacing

* ci: auto-formatting prettier issues

* Incorporating suggestions from Carolina

---------

Co-authored-by: achuribooks <[email protected]>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 4844027)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-0:
- docs: unhyphenate open source (#4284)
- docs: DOC-1118 Image Conversion to webp (#2439)
- docs: updated URLs to use file path context
version-4-1 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-1:
- docs: unhyphenate open source (#4284)
- docs: DOC-1118 Image Conversion to webp (#2439)
version-4-2 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-2:
- docs: unhyphenate open source (#4284)
- docs: DOC-1118 Image Conversion to webp (#2439)
version-4-3 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-3:
- docs: unhyphenate open source (#4284)
version-4-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-4:
- docs: unhyphenate open source (#4284)
version-4-5

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 5100

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

karl-cardenas-coding pushed a commit that referenced this pull request Jan 8, 2025
* Initial commit for Maintenance Mode documentation

* Webp image conversion

* Minor updates

* Added procedure and validation to Disable Maintenance Mode section

* Minor cleanup; additional x-refs; affirmation that scans are intentionally disabled

* ci: auto-formatting prettier issues

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Minor style guide and spelling fixes

* ci: auto-formatting prettier issues

* Fixed spacing caused by merge conflict

* ci: auto-formatting prettier issues

* Spacing

* ci: auto-formatting prettier issues

* Incorporating suggestions from Carolina

---------

Co-authored-by: achuribooks <[email protected]>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 4844027)

Co-authored-by: Amanda Churi Filanowski <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 backport-version-4-5 Backport changes to the version-4-5 branch.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants