Skip to content

Commit

Permalink
Merge pull request #20 from aj11anuj/Branch-102
Browse files Browse the repository at this point in the history
Added documentation for concepts _index.md file
  • Loading branch information
dipankardas011 committed May 30, 2024
2 parents 916ef38 + 3db4a50 commit 51db43b
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 10 deletions.
8 changes: 1 addition & 7 deletions content/en/docs/Concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,4 @@ description: >
Concepts around ksctl core
---

{{% pageinfo %}}
Related to the overall managers and controllers
{{% /pageinfo %}}

For many projects, users may not need much information beyond the information in the [Overview](/docs), so this section is **optional**. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture.

Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult.
This section will help you to learn about the underlying system of Ksctl. It will help you to obtain a deeper understanding of how Ksctl works.
2 changes: 1 addition & 1 deletion content/en/docs/Concepts/ksctl cloud controller.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Cloud Controller
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
The Component of Ksctl responsible for creating and managing clusters for different Cloud platforms.
categories: [Examples]
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Concepts/ksctl distro controller.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Distribution Controller
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
The Component of Ksctl responsible for selecting the type of Bootstrap solution (Kubeadm or K3s).
categories: [Examples]
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Concepts/ksctl manager.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Core Manager
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
The Component of Ksctl responsible for managing Cloud controller and Distribution controller. It has multiple types of managers
categories: [Examples]
---

Expand Down

0 comments on commit 51db43b

Please sign in to comment.