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

Merge concepts and design into single document #374

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

smadhura
Copy link
Contributor

Currently concepts and design are two separate documents, but with a lot of same or similar information, creating confusion.

Merging the content from the two into a single document, for simplification

@smadhura smadhura requested a review from cruizen December 15, 2022 18:51
@smadhura smadhura temporarily deployed to arlon December 15, 2022 18:51 — with GitHub Actions Inactive
@smadhura smadhura requested a review from bcle December 15, 2022 18:52
docs/concepts.md Outdated

A cluster spec contains desired settings when creating a new cluster.
The Cluster Specification, also called the 'Base Cluster' contains the desired settings when creating a new cluster.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Cluster Spec and Base Cluster are not identical, even if they have similarities. Why merge the concepts here? And why do all of this if this is going to be replaced by Cluster Templates?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay I fixed it to keep both in the concepts document. please take another look

@smadhura smadhura temporarily deployed to arlon December 15, 2022 20:44 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 15, 2022 20:47 — with GitHub Actions Inactive
@smadhura smadhura requested a review from bcle December 15, 2022 20:47
@smadhura smadhura temporarily deployed to arlon December 15, 2022 21:06 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 15, 2022 21:15 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 15, 2022 21:17 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 15, 2022 21:18 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 15, 2022 21:20 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 15, 2022 21:21 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 15, 2022 21:25 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 15, 2022 21:29 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 16, 2022 00:25 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 16, 2022 00:30 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 16, 2022 00:44 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 16, 2022 00:49 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 16, 2022 00:58 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 16, 2022 01:00 — with GitHub Actions Inactive
@smadhura smadhura temporarily deployed to arlon December 16, 2022 01:01 — with GitHub Actions Inactive

To know more about 'Base Cluster', read about it [here](./baseclusters.md)

## Cluster Chart
Copy link
Collaborator

Choose a reason for hiding this comment

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

The cluster chart is only used by gen1 clusters. Gen2 clusters created from base clusters don't use the cluster chart. It's confusing to describe both base clusters and cluster charts in the same document.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay then I will remove the cluster chart stuff from the 0.10 docs version, once I am able to see it on the doc site

@cruizen cruizen temporarily deployed to arlon December 21, 2022 06:21 — with GitHub Actions Inactive
@codecov
Copy link

codecov bot commented Dec 21, 2022

Codecov Report

Merging #374 (8423ff6) into main (1974305) will increase coverage by 0.63%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main     #374      +/-   ##
==========================================
+ Coverage   28.71%   29.35%   +0.63%     
==========================================
  Files          25       25              
  Lines        1654     1618      -36     
==========================================
  Hits          475      475              
+ Misses       1132     1096      -36     
  Partials       47       47              
Impacted Files Coverage Δ
pkg/gitutils/manifests.go 0.00% <0.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@cruizen cruizen added the needs help Needs assistance from a contributor label Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs help Needs assistance from a contributor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants