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: refactor taints guide DOC-1272 #3395

Merged
merged 14 commits into from
Jul 18, 2024
Merged

Conversation

addetz
Copy link
Contributor

@addetz addetz commented Jul 17, 2024

Describe the Change

This PR refactors the Node Labels and Taints page by splitting it up into two separate pages, one for Taints and one for Node Labels. Both pages use the How-To layout.

Changed Pages

💻 Node Labels
💻 Taints and Tolerations

Jira Tickets

🎫 DOC-1272

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.

@addetz addetz requested a review from a team as a code owner July 17, 2024 16:39
Copy link

netlify bot commented Jul 17, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 1f2f66f
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/66992d32e980b60008a17f5c
😎 Deploy Preview https://deploy-preview-3395--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 75.6%, saving 1.18 MB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/clusters_cluster-management_node-labels_cluster-creation-labels.webp 400.00 KB 85.18 KB -78.7% View diff
static/assets/docs/images/clusters_cluster-management_node-labels_kubeconfig-download.webp 561.00 KB 114.49 KB -79.6% View diff
static/assets/docs/images/clusters_cluster-management_taints_cluster-creation-taints.webp 79.31 KB 77.11 KB -2.8% View diff
static/assets/docs/images/clusters_cluster-management_taints_kubeconfig-download.webp 561.00 KB 114.49 KB -79.6% View diff

711 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.8%, saving 5.65 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/clusters_cluster-management_node-labels_cluster-creation-labels.webp 85.18 KB 83.69 KB -1.7% View diff
static/assets/docs/images/clusters_cluster-management_node-labels_kubeconfig-download.webp 114.49 KB 112.41 KB -1.8% View diff
static/assets/docs/images/clusters_cluster-management_taints_kubeconfig-download.webp 114.49 KB 112.41 KB -1.8% View diff

712 images did not require optimisation.

@addetz addetz force-pushed the refactor-taints-guide-doc-1272 branch from e651aea to b022c6b Compare July 17, 2024 17:29
@addetz addetz force-pushed the refactor-taints-guide-doc-1272 branch from b022c6b to 84fc1b7 Compare July 17, 2024 17:57
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

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

Great changes. I left some minor suggestions below 🚀

@addetz addetz added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 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 labels Jul 18, 2024
@addetz addetz force-pushed the refactor-taints-guide-doc-1272 branch from e47ea7c to b33e246 Compare July 18, 2024 13:59
@addetz addetz merged commit 7ae0c53 into master Jul 18, 2024
17 checks passed
@addetz addetz deleted the refactor-taints-guide-doc-1272 branch July 18, 2024 15:44
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
(cherry picked from commit 7ae0c53)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
(cherry picked from commit 7ae0c53)
@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: DOC-1118 Image Conversion to webp (#2439)
- chore: upgrade to docusaurus 3.1.1 (#2135)
- docs: Provide missing Autocale information (#1857) DOC-897
- docs: updated URLs to use file path context
version-3-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-3-4:
- docs: DOC-1118 Image Conversion to webp (#2439)
- docs: DOC-936 DOC-916 DOC-928 DOC-929 zure Permissons (#2077)
- docs: Provide missing Autocale information (#1857) DOC-897
- Refactor/restructure cluster & app profiles sections (#1551)
- 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: DOC-1118 Image Conversion to webp (#2439)
- chore: upgrade to docusaurus 3.1.1 (#2135)
version-4-2 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-2:
- docs: DOC-1118 Image Conversion to webp (#2439)
- chore: upgrade to docusaurus 3.1.1 (#2135)
- replace caution with warning (#2039)
version-4-3
version-4-4

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

Manual backport

To create the backport manually run:

backport --pr 3395

Questions ?

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

vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

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

Co-authored-by: Adelina Simion <[email protected]>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

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

Co-authored-by: Adelina Simion <[email protected]>
addetz added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
addetz added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
addetz added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
addetz added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
addetz added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review



* Apply suggestions from code review



* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
addetz added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272 (#3395)

* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>

* docs: revert api.json

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
addetz added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272 (#3395)

* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix formatting

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
addetz added a commit that referenced this pull request Jul 18, 2024
* docs: refactor taints guide DOC-1272 (#3395)

* docs: refactor taints guide DOC-1272

* docs: add node labels guide DOC-1272

* docs: fix vale DOC-1272

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken anchors DOC-1272

* docs: adjust wording on new pages DOC-1272

* docs:fix formatting DOC-1272

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix indentation of pages DOC-1272

* docs: tweak intro to compare node labels and taints DOC-1272

* docs: fix vale DOC-1272

* docs: fix formatting DOC-1272

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix broken links in new pages

* docs: fix additional broken links

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[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-3-4 Backport change to version 3.4 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants