Skip to content

Commit bbc1155

Browse files
committed
concepts
1 parent ddb4bf6 commit bbc1155

File tree

6 files changed

+21
-5
lines changed

6 files changed

+21
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
node_modules
2+
.docusaurus

docs/about/comparison.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/about/implementation.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/concepts/concepts.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,18 @@
11
# Core concepts
2+
3+
For the sake of the rest of the docs to be more clear, here are some Cyclops-specific terms that will be used:
4+
5+
<strong>Module</strong> - an umbrella for all the Kubernetes resources your application needs to work as expected. For
6+
example, your application might require a deployment, a service, and an ingress to do its job. All of those are
7+
abstracted under a Cyclops Module. <br /><br />
8+
9+
10+
<strong>Template</strong> - each Module references a Template that maps values from the Module into a valid Kubernetes
11+
manifest. <br /><br />
12+
13+
<strong>Template origin</strong> - templates can live on different places. You can store your templates as Helm charts,
14+
on git, or even inside Cyclops. <br /><br />
15+
16+
<strong>Template version</strong> - a part of the template reference in each Module is the version of the template.
17+
Templates can evolve and change over time, and in order to maintain changes in your system, you can reference different
18+
template versions in different Modules. <br /><br />

sidebars.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ const sidebars = {
2525
label: 'About',
2626
items: [
2727
'about/about',
28-
'about/comparison',
29-
'about/implementation'
28+
// 'about/comparison',
29+
// 'about/implementation'
3030
],
3131
},
3232
{

src/pages/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ function HomepageHeader() {
2323
<div className={styles.buttons}>
2424
<Link
2525
className="button button--secondary button--lg"
26-
to="/docs/installation/prerequisites">
26+
to="/docs/about">
2727
Check it out
2828
</Link>
2929
</div>

0 commit comments

Comments
 (0)