Skip to content

Commit

Permalink
chore: release docs for colony 0.1 (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
fharper authored Sep 3, 2024
1 parent 23b4c5a commit 6df640a
Show file tree
Hide file tree
Showing 40 changed files with 446 additions and 77 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"version":{"pluginId":"default","version":"0.1","label":"0.1","banner":null,"badge":true,"noIndex":false,"className":"docs-version-0.1","isLast":true,"docsSidebars":{"myAutogeneratedSidebar":[{"type":"link","label":"Colony","href":"/docs/","docId":"index","unlisted":false},{"type":"link","label":"Clusters","href":"/docs/clusters/","docId":"clusters/index","unlisted":false},{"type":"link","label":"Templates","href":"/docs/templates/","docId":"templates/index","unlisted":false}]},"docs":{"clusters/index":{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","sidebar":"myAutogeneratedSidebar"},"index":{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","sidebar":"myAutogeneratedSidebar"},"templates/index":{"id":"templates/index","title":"Templates","description":"Ubuntu Template - Assets","sidebar":"myAutogeneratedSidebar"}}}}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"version":{"pluginId":"default","version":"current","label":"Next","banner":"unreleased","badge":true,"noIndex":false,"className":"docs-version-current","isLast":false,"docsSidebars":{"myAutogeneratedSidebar":[{"type":"link","label":"Colony","href":"/docs/next/","docId":"index","unlisted":false},{"type":"link","label":"Clusters","href":"/docs/next/clusters/","docId":"clusters/index","unlisted":false},{"type":"link","label":"Templates","href":"/docs/next/templates/","docId":"templates/index","unlisted":false}]},"docs":{"clusters/index":{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","sidebar":"myAutogeneratedSidebar"},"index":{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","sidebar":"myAutogeneratedSidebar"},"templates/index":{"id":"templates/index","title":"Templates","description":"Ubuntu Template - Assets","sidebar":"myAutogeneratedSidebar"}}}}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"source": "@site/docs/clusters/index.md",
"sourceDirName": "clusters",
"slug": "/clusters/",
"permalink": "/clusters/",
"permalink": "/docs/next/clusters/",
"draft": false,
"unlisted": false,
"tags": [],
Expand All @@ -14,10 +14,10 @@
"sidebar": "myAutogeneratedSidebar",
"previous": {
"title": "Colony",
"permalink": "/"
"permalink": "/docs/next/"
},
"next": {
"title": "Templates",
"permalink": "/templates/"
"permalink": "/docs/next/templates/"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"source": "@site/docs/index.md",
"sourceDirName": ".",
"slug": "/",
"permalink": "/",
"permalink": "/docs/next/",
"draft": false,
"unlisted": false,
"tags": [],
Expand All @@ -17,6 +17,6 @@
"sidebar": "myAutogeneratedSidebar",
"next": {
"title": "Clusters",
"permalink": "/clusters/"
"permalink": "/docs/next/clusters/"
}
}
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"id": "templates/index",
"title": "Templates",
"description": "One thing you can do with the machines discovered by colony is to use one of our available templates to install a specific operating system easily on one or multiples machines. For now we support Talos Linux, and Ubuntu, but more templates will be added soon. If you have any suggestions, feel free to let us know in the #colony-templates channel in our Slack community.",
"description": "Ubuntu Template - Assets",
"source": "@site/docs/templates/index.md",
"sourceDirName": "templates",
"slug": "/templates/",
"permalink": "/templates/",
"permalink": "/docs/next/templates/",
"draft": false,
"unlisted": false,
"tags": [],
Expand All @@ -14,6 +14,6 @@
"sidebar": "myAutogeneratedSidebar",
"previous": {
"title": "Clusters",
"permalink": "/clusters/"
"permalink": "/docs/next/clusters/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "clusters/index",
"title": "Clusters",
"description": "One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.",
"source": "@site/versioned_docs/version-0.1/clusters/index.md",
"sourceDirName": "clusters",
"slug": "/clusters/",
"permalink": "/docs/clusters/",
"draft": false,
"unlisted": false,
"tags": [],
"version": "0.1",
"frontMatter": {},
"sidebar": "myAutogeneratedSidebar",
"previous": {
"title": "Colony",
"permalink": "/docs/"
},
"next": {
"title": "Templates",
"permalink": "/docs/templates/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"id": "index",
"title": "Colony",
"description": "colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.",
"source": "@site/versioned_docs/version-0.1/index.md",
"sourceDirName": ".",
"slug": "/",
"permalink": "/docs/",
"draft": false,
"unlisted": false,
"tags": [],
"version": "0.1",
"sidebarPosition": 1,
"frontMatter": {
"sidebar_position": 1
},
"sidebar": "myAutogeneratedSidebar",
"next": {
"title": "Clusters",
"permalink": "/docs/clusters/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"id": "templates/index",
"title": "Templates",
"description": "Ubuntu Template - Assets",
"source": "@site/versioned_docs/version-0.1/templates/index.md",
"sourceDirName": "templates",
"slug": "/templates/",
"permalink": "/docs/templates/",
"draft": false,
"unlisted": false,
"tags": [],
"version": "0.1",
"frontMatter": {},
"sidebar": "myAutogeneratedSidebar",
"previous": {
"title": "Clusters",
"permalink": "/docs/clusters/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"allContent":{"docusaurus-plugin-content-docs":{"default":{"loadedVersions":[{"versionName":"current","label":"Next","banner":"unreleased","badge":true,"noIndex":false,"className":"docs-version-current","path":"/docs/next","tagsPath":"/docs/next/tags","isLast":false,"sidebarFilePath":"/Users/fharper/Documents/code/k1/colony-docs/sidebars.js","contentPath":"/Users/fharper/Documents/code/k1/colony-docs/docs","contentPathLocalized":"/Users/fharper/Documents/code/k1/colony-docs/i18n/en/docusaurus-plugin-content-docs/current","docs":[{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","source":"@site/docs/clusters/index.md","sourceDirName":"clusters","slug":"/clusters/","permalink":"/docs/next/clusters/","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Colony","permalink":"/docs/next/"},"next":{"title":"Templates","permalink":"/docs/next/templates/"}},{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/docs/next/","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"myAutogeneratedSidebar","next":{"title":"Clusters","permalink":"/docs/next/clusters/"}},{"id":"templates/index","title":"Templates","description":"Ubuntu Template - Assets","source":"@site/docs/templates/index.md","sourceDirName":"templates","slug":"/templates/","permalink":"/docs/next/templates/","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Clusters","permalink":"/docs/next/clusters/"}}],"drafts":[],"sidebars":{"myAutogeneratedSidebar":[{"type":"doc","id":"index"},{"type":"doc","label":"Clusters","id":"clusters/index"},{"type":"doc","label":"Templates","id":"templates/index"}]}},{"versionName":"0.1","label":"0.1","banner":null,"badge":true,"noIndex":false,"className":"docs-version-0.1","path":"/docs/","tagsPath":"/docs/tags","isLast":true,"routePriority":-1,"sidebarFilePath":"/Users/fharper/Documents/code/k1/colony-docs/versioned_sidebars/version-0.1-sidebars.json","contentPath":"/Users/fharper/Documents/code/k1/colony-docs/versioned_docs/version-0.1","contentPathLocalized":"/Users/fharper/Documents/code/k1/colony-docs/i18n/en/docusaurus-plugin-content-docs/version-0.1","docs":[{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","source":"@site/versioned_docs/version-0.1/clusters/index.md","sourceDirName":"clusters","slug":"/clusters/","permalink":"/docs/clusters/","draft":false,"unlisted":false,"tags":[],"version":"0.1","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Colony","permalink":"/docs/"},"next":{"title":"Templates","permalink":"/docs/templates/"}},{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","source":"@site/versioned_docs/version-0.1/index.md","sourceDirName":".","slug":"/","permalink":"/docs/","draft":false,"unlisted":false,"tags":[],"version":"0.1","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"myAutogeneratedSidebar","next":{"title":"Clusters","permalink":"/docs/clusters/"}},{"id":"templates/index","title":"Templates","description":"Ubuntu Template - Assets","source":"@site/versioned_docs/version-0.1/templates/index.md","sourceDirName":"templates","slug":"/templates/","permalink":"/docs/templates/","draft":false,"unlisted":false,"tags":[],"version":"0.1","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Clusters","permalink":"/docs/clusters/"}}],"drafts":[],"sidebars":{"myAutogeneratedSidebar":[{"type":"doc","id":"index"},{"type":"doc","label":"Clusters","id":"clusters/index"},{"type":"doc","label":"Templates","id":"templates/index"}]}}]}},"docusaurus-plugin-content-pages":{"default":null},"docusaurus-plugin-debug":{},"docusaurus-theme-classic":{},"docusaurus-bootstrap-plugin":{},"docusaurus-mdx-fallback-plugin":{}}}
20 changes: 16 additions & 4 deletions .docusaurus/docusaurus.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ export default {
"title": "Colony Documentation",
"tagline": "Colony",
"favicon": "img/favicon.ico",
"url": "https://your-docusaurus-site.example.com",
"baseUrl": "/",
"url": "https://colony.konstruct.io",
"baseUrl": "/docs/",
"onBrokenLinks": "throw",
"onBrokenMarkdownLinks": "warn",
"i18n": {
Expand Down Expand Up @@ -41,8 +41,20 @@ export default {
"src": "img/colony.svg",
"href": "https://colony.konstruct.io/docs"
},
"hideOnScroll": false,
"items": []
"items": [
{
"type": "docsVersionDropdown",
"position": "right",
"dropdownItemsBefore": [],
"dropdownItemsAfter": []
},
{
"href": "https://konstruct.io/colony",
"label": "Website",
"position": "right"
}
],
"hideOnScroll": false
},
"footer": {
"style": "dark",
Expand Down
45 changes: 39 additions & 6 deletions .docusaurus/globalData.json
Original file line number Diff line number Diff line change
@@ -1,36 +1,69 @@
{
"docusaurus-plugin-content-docs": {
"default": {
"path": "/",
"path": "/docs/",
"versions": [
{
"name": "current",
"label": "Next",
"isLast": false,
"path": "/docs/next",
"mainDocId": "index",
"docs": [
{
"id": "clusters/index",
"path": "/docs/next/clusters/",
"sidebar": "myAutogeneratedSidebar"
},
{
"id": "index",
"path": "/docs/next/",
"sidebar": "myAutogeneratedSidebar"
},
{
"id": "templates/index",
"path": "/docs/next/templates/",
"sidebar": "myAutogeneratedSidebar"
}
],
"draftIds": [],
"sidebars": {
"myAutogeneratedSidebar": {
"link": {
"path": "/docs/next/",
"label": "index"
}
}
}
},
{
"name": "0.1",
"label": "0.1",
"isLast": true,
"path": "/",
"path": "/docs/",
"mainDocId": "index",
"docs": [
{
"id": "clusters/index",
"path": "/clusters/",
"path": "/docs/clusters/",
"sidebar": "myAutogeneratedSidebar"
},
{
"id": "index",
"path": "/",
"path": "/docs/",
"sidebar": "myAutogeneratedSidebar"
},
{
"id": "templates/index",
"path": "/templates/",
"path": "/docs/templates/",
"sidebar": "myAutogeneratedSidebar"
}
],
"draftIds": [],
"sidebars": {
"myAutogeneratedSidebar": {
"link": {
"path": "/",
"path": "/docs/",
"label": "index"
}
}
Expand Down
Loading

0 comments on commit 6df640a

Please sign in to comment.