From 6d6ba0c70ef05578bea170a545b0f4c4ebebdc24 Mon Sep 17 00:00:00 2001 From: Dave Mount Date: Wed, 16 Aug 2023 18:41:00 -0700 Subject: [PATCH] Feature/gen-194 (#32) * feat: restructure everything putting in recommended structure, while being mindful of how we want to organize. - lots of work on company section - new guidelines for 1-1s - some other clean ups - add release checklist - add release checklist procedure - about handbook - show more levels on sidebar - remove dead pages, add copyright notice - simplify title --- docs/.vitepress/config.ts | 165 ++++++++++++------ docs/bizops/index.md | 12 ++ docs/company/communication.md | 20 +++ docs/company/culture.md | 59 +++++++ docs/company/employees/1on1s.md | 28 +++ docs/{ => company}/employees/index.md | 21 ++- docs/{ => company}/employees/performance.md | 0 docs/company/goals/june2023.md | 2 +- docs/company/index.md | 109 +++++++++++- docs/company/mission.md | 3 - docs/company/operating-procedures.md | 18 ++ docs/company/vision.md | 57 ------ docs/customers/index.md | 14 ++ .../support}/assessments.md | 0 .../support}/customer-calls.md | 0 .../support}/index.md | 0 .../support}/keeping-in-touch.md | 0 .../support}/performance-tuning.md | 0 .../support}/tracking.md | 0 .../support}/troubleshooting.md | 0 .../demo/demo-system-design.drawio.svg | 0 .../demo/demo-system-mindmap.md | 0 .../demo/impl-notes-take-1.md | 0 .../demo/index.md | 0 docs/{ => engineering}/development/index.md | 1 + .../development/infrastructure.md | 0 .../development/release-checklist.md | 22 +++ .../development/release-management.md | 1 + docs/engineering/index.md | 17 ++ docs/engineering/product/index.md | 16 ++ .../product}/product-roadmap.md | 3 +- docs/engineering/quality/index.md | 8 + docs/engineering/systemops/index.md | 12 ++ docs/index.md | 23 ++- docs/{company => }/marketing/branding.md | 0 docs/{company => }/marketing/index.md | 0 docs/{company => }/marketing/social-media.md | 4 +- .../marketing/strategy-for-adoption.md | 0 docs/sales/index.md | 8 + docs/security/index.md | 11 ++ 40 files changed, 496 insertions(+), 138 deletions(-) create mode 100644 docs/bizops/index.md create mode 100644 docs/company/communication.md create mode 100644 docs/company/culture.md create mode 100644 docs/company/employees/1on1s.md rename docs/{ => company}/employees/index.md (72%) rename docs/{ => company}/employees/performance.md (100%) delete mode 100644 docs/company/mission.md create mode 100644 docs/company/operating-procedures.md delete mode 100644 docs/company/vision.md create mode 100644 docs/customers/index.md rename docs/{consulting => customers/support}/assessments.md (100%) rename docs/{consulting => customers/support}/customer-calls.md (100%) rename docs/{consulting => customers/support}/index.md (100%) rename docs/{consulting => customers/support}/keeping-in-touch.md (100%) rename docs/{consulting => customers/support}/performance-tuning.md (100%) rename docs/{consulting => customers/support}/tracking.md (100%) rename docs/{consulting => customers/support}/troubleshooting.md (100%) rename docs/{development => engineering}/demo/demo-system-design.drawio.svg (100%) rename docs/{development => engineering}/demo/demo-system-mindmap.md (100%) rename docs/{development => engineering}/demo/impl-notes-take-1.md (100%) rename docs/{development => engineering}/demo/index.md (100%) rename docs/{ => engineering}/development/index.md (99%) rename docs/{ => engineering}/development/infrastructure.md (100%) create mode 100644 docs/engineering/development/release-checklist.md rename docs/{ => engineering}/development/release-management.md (99%) create mode 100644 docs/engineering/index.md create mode 100644 docs/engineering/product/index.md rename docs/{development => engineering/product}/product-roadmap.md (98%) create mode 100644 docs/engineering/quality/index.md create mode 100644 docs/engineering/systemops/index.md rename docs/{company => }/marketing/branding.md (100%) rename docs/{company => }/marketing/index.md (100%) rename docs/{company => }/marketing/social-media.md (88%) rename docs/{company => }/marketing/strategy-for-adoption.md (100%) create mode 100644 docs/sales/index.md create mode 100644 docs/security/index.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 49ed247..f264b7a 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,15 +1,19 @@ -import { defineConfig } from 'vitepress' +import { defineConfig, DefaultTheme } from 'vitepress' import { withMermaid } from 'vitepress-plugin-mermaid' // https://vitepress.dev/reference/site-config export default withMermaid( defineConfig({ - title: 'Koor Handbook', + title: 'Handbook', titleTemplate: ':title | Koor Technologies, Inc.', description: 'How we run our business', + + lastUpdated: true, + head: [ ['link', { rel: 'icon', type: 'image/x-icon', href: '/favicon.png' }], ], + themeConfig: { // https://vitepress.dev/reference/default-theme-config logo: 'koor-logo.png', @@ -17,19 +21,23 @@ export default withMermaid( nav: [ { text: 'Home', link: '/' }, { text: 'Company', link: '/company/' }, - { text: 'Employees', link: '/employees/' }, - { text: 'Development', link: '/development/' }, - { text: 'Support', link: '/consulting/' }, - { text: 'Examples', link: '/markdown-examples' }, + { text: 'Development', link: '/engineering/development/' }, + { text: 'Product', link: '/engineering/product/' }, + { text: 'Marketing', link: '/marketing/' }, + { text: 'Support', link: '/customers/support/' }, ], sidebar: [ { text: 'Company', items: [ - { text: 'About', link: '/company/' }, - { text: 'Mission', link: '/company/mission' }, - { text: 'Vision', link: '/company/vision' }, + { text: 'About Koor', link: '/company/' }, + { text: 'Culture', link: '/company/culture' }, + { text: 'Communication', link: '/company/communication' }, + { + text: 'Operating Procedures', + link: '/company/operating-procedures', + }, { text: 'Goals', link: '/company/goals/', @@ -38,10 +46,6 @@ export default withMermaid( text: '2023', link: '/company/goals/annual2023', }, - { - text: 'June 2023', - link: '/company/goals/june2023', - }, { text: 'July-Aug 2023', link: '/company/goals/july-aug2023', @@ -49,76 +53,132 @@ export default withMermaid( ], }, { - text: 'Marketing', - link: '/company/marketing/', + text: 'Employees', items: [ - { text: 'Branding', link: '/company/marketing/branding' }, - { - text: 'Social Media', - link: '/company/marketing/social-media', - }, - { - text: 'Strategy for Adoption', - link: '/company/marketing/strategy-for-adoption', - }, + { text: 'Who Powers Koor', link: '/company/employees/' }, + { text: '1-on-1s', link: '/company/employees/1on1s' }, + { text: 'Performance', link: '/company/employees/performance' }, ], }, ], }, { - text: 'Employees', - items: [ - { text: 'Who Powers Koor', link: '/employees/' }, - { text: 'Performance', link: '/employees/performance' }, - ], - }, - { - text: 'Development', + text: 'Engineering', + link: '/engineering/', items: [ { - text: 'Product Roadmap', - link: '/development/product-roadmap', + text: 'Product Planning', + link: '/engineering/product/', + items: [ + { + text: 'Product Roadmap', + link: '/engineering/product/product-roadmap', + }, + ], + }, + { + text: 'Development', + items: [ + { text: 'Practices', link: '/engineering/development/' }, + { + text: 'Release Management', + items: [ + { + text: 'Procedures', + link: '/engineering/development/release-management', + }, + { + text: 'Release Checklist', + link: '/engineering/development/release-checklist', + }, + ], + }, + { + text: 'Infrastructure', + link: '/engineering/development/infrastructure', + }, + ], }, - { text: 'Development Practices', link: '/development/' }, { - text: 'Release Management', - link: '/development/release-management', + text: 'Quality', + link: '/engineering/quality/', }, - { text: 'Infrastructure', link: '/development/infrastructure' }, { text: 'Demo System', items: [ { text: 'Overview', - link: '/development/demo/', + link: '/engineering/demo/', }, { text: 'Vision for Demo System', - link: '/development/demo/demo-system-mindmap', + link: '/engineering/demo/demo-system-mindmap', }, { text: '1st Impl Attempt', - link: '/development/demo/impl-notes-take-1', + link: '/engineering/demo/impl-notes-take-1', + }, + ], + }, + { + text: 'System Operations', + link: '/engineering/systemops/', + }, + ], + }, + { + text: 'Customer Success', + link: '/customers/', + items: [ + { + text: 'Support', + link: '/customers/support/', + items: [ + { text: 'Tracking Hours', link: '/customers/support/tracking' }, + { text: 'Assessments', link: '/customers/support/assessments' }, + { + text: 'Customer Calls', + link: '/customers/support/customer-calls', + }, + { + text: 'Keeping in Touch', + link: '/customers/support/keeping-in-touch', + }, + { + text: 'Performance Tuning', + link: '/customers/support/performance-tuning', + }, + { + text: 'Troubleshooting', + link: '/customers/support/troubleshooting', }, ], }, ], }, { - text: 'Support', + text: 'Marketing', + link: '/marketing/', items: [ - { text: 'Consulting Practice', link: '/consulting/' }, - { text: 'Tracking Hours', link: '/consulting/tracking' }, - { text: 'Assessments', link: '/consulting/assessments' }, - { text: 'Customer Calls', link: '/consulting/customer-calls' }, - { text: 'Keeping in Touch', link: '/consulting/keeping-in-touch' }, + { text: 'Branding', link: '/marketing/branding' }, { - text: 'Performance Tuning', - link: '/consulting/performance-tuning', + text: 'Social Media', + link: '/marketing/social-media', + }, + { + text: 'Strategy for Adoption', + link: '/marketing/strategy-for-adoption', }, - { text: 'Troubleshooting', link: '/consulting/troubleshooting' }, ], }, + { + text: 'Sales', + link: '/sales/', + }, + { + text: 'Security', + link: '/security/', + }, ], socialLinks: [ @@ -129,6 +189,11 @@ export default withMermaid( }, { icon: 'twitter', link: 'https://twitter.com/koor_tech' }, ], + + footer: { + message: 'MIT License', + copyright: 'Copyright © 2022-present Koor Technologies, Inc.', + }, }, markdown: { xhtmlOut: true, diff --git a/docs/bizops/index.md b/docs/bizops/index.md new file mode 100644 index 0000000..0939ac9 --- /dev/null +++ b/docs/bizops/index.md @@ -0,0 +1,12 @@ +--- +title: Business Operations +--- + +# Business Operations + +## Finance: Accounting, payroll, expenses + +## Tooling + +## People Operations: Hiring, benefits, celebrations, gifts, departures + diff --git a/docs/company/communication.md b/docs/company/communication.md new file mode 100644 index 0000000..c6ac4f2 --- /dev/null +++ b/docs/company/communication.md @@ -0,0 +1,20 @@ +--- +title: Communication +--- + +# Communication + +## General guidelines + + +## Levels of confidentiality + + +## Internal communication + + +## Meetings + + +## Using Slack, email, video conferencing (Zoom / Meet / Jitsi) + diff --git a/docs/company/culture.md b/docs/company/culture.md new file mode 100644 index 0000000..3dbd03e --- /dev/null +++ b/docs/company/culture.md @@ -0,0 +1,59 @@ +--- +title: Culture +outline: [2, 3] +--- + +# Culture + +## Values + + +## Life at Koor + + +## Handbook + +Koor is a fully remote company. That has a lot of advantages. To name one, we can bring the best talent the world has to offer wherever talented people have access to the Internet. For another, we save a lot of time we would otherwise waste commuting to and from an office. + +A cornerstone that allows remote work to be effective is a handbook that is the single-source-of-truth for how we operate. You are reading the handbook now. If we have done a thorough and careful job, many questions are answered in these pages, saving people time in not having to repeat ourselves as new people come into the company, or we engage in a particular process for the first time, or we have to remember how to do that thing we don't do very often. + +If you need further convincing that maintaining and depending on a common handbook is vital to running a remote company, [read this](https://about.gitlab.com/company/culture/all-remote/handbook-first-documentation). + +### What goes in the handbook + +The handbook is meant to include just about everything we do and how we do it. It may be easier to define what belongs here by listing what does not belong here. If something is not in the following list, perhaps the handbook is the best place for it. + +**Things to put elsewhere** + +- Technical documentation: + - Docs that explain how to use software (dev guide, API specs, etc.) we build should live in the software's source [repository](https://github.com/koor-tech). + - All other technical information and knowledge sharing goes in our [Knowledge Center](https://kb.koor.tech/). + - Design artifacts for released software belong in the Knowledge Center or source repo. Choose one and cross link from the other. + - Project work is tracked in Linear. +- Company Secrets + - We do have a few secrets, although the line between private and public information may be more lenient than you expect. + - Any related to system access - passwords, recovery keys, account numbers, and so on - should be stored in 1Password. + - We also have a private handbook. Ask if you think you need to see it. +- Customer information + - We never want to share or leak private information about our customers, primarily for their privacy, which is reason enough. +- Personnel information + - We also do not want to expose sensitive employee information. That belongs in our HR systems only. + + +### How to add content + +This handbook is written primarily in markdown, which makes it easy for anyone to contribute. The pages are built into a static website by the VitePress framework. We can extend the framework as needed using VueJS, the JavaScript framework that VitePress is built on. + +If you are on the less technical side of things, never mind any of that. Just write the content in a Linear issue, and buddy up with someone who can help get it into the mix. + + +## Rituals + +- Watercooler - for social chatting (although work slips in from time to time). +- Demo Time - share something with the group, something you worked on, a bit of knowledge, someone cool that you found, a problem you are having, anything goes. +- Retrospectives - time to think about what is working and what might be improved. + + +## Team Stories + + diff --git a/docs/company/employees/1on1s.md b/docs/company/employees/1on1s.md new file mode 100644 index 0000000..8ff0537 --- /dev/null +++ b/docs/company/employees/1on1s.md @@ -0,0 +1,28 @@ +--- +title: Weekly employee-manager 1-on-1 meetings +--- + +# Weekly employee-manager 1-on-1 meetings + +## Purpose + +Of the many good reasons to have 1-on-1s, we will focus on three. + +First, one-on-ones are a time to reflect on recent accomplishments and to realign on the next set of challenges. They are also a good time to discuss work matters of a more individual or personal nature: career aspirations, performance feedback, general well-being, etc. + +Second, one-on-ones provide an opportunity to chronicle the work you are doing as it is happening. It's a lot easier to remember what you have done with a weekly journal of what you have done. + +Third, one-on-ones give you and your manager a chance to build your working relationship, to develop trust, and to help each other make better contributions to the company. + + +## General procedure + +As a standard practice, each employee will meet with his or her manager on a weekly basis. The meeting will block a half-hour slot in the calendar. While it is fine to make full use of the time, the meeting can end once all of the topics are covered. + +The calendar invite will include the recurring Meet or Zoom meeting and a shared Google document for 1-1 notes. + +The employee can make this easier by preparing for the meeting. Before the meeting starts, open the shared notes and create a new heading with the meeting date. Copy the template, and answer the questions. It is okay to summarize, or add as much detail as needed to be clear. + +When your notes are ready, you can @ notify your manager in the document. Giving your manager time to read the notes beforehand will either speed up the meeting or allow you to discuss matters more deeply. Also, it gives you time to remember additional points. + +During the meeting, have the notes open and additional thoughts that come up. diff --git a/docs/employees/index.md b/docs/company/employees/index.md similarity index 72% rename from docs/employees/index.md rename to docs/company/employees/index.md index bc6dc63..dd3aee0 100644 --- a/docs/employees/index.md +++ b/docs/company/employees/index.md @@ -1,3 +1,18 @@ + + # Koor Techies ## Who We Are @@ -8,6 +23,8 @@ We are a remote team where each member is in a completely different location, sp Of all the names we tried, Koor Techies seems to sum things up. We are open to other ideas. + + ## Watercooler One of our standing meetings is the watercooler. This is primarily a social meeting, designed to help us learn more about each other and to stay in touch with what's going on in life. Unlike a physical watercooler where people meet more-or-less by accident, our watercooler is an intentional opportunity to socialize. @@ -18,6 +35,6 @@ While it is okay to discuss work, it is better for this to be more of a fun conn Once you know you will take time off, make an annoucement in the people-ops channel to let the team know. For extended vacation (personal time off), let your manager know before announcing in case any adjustments to your plans are needed. - -- [Performance](performance.html) +- [1-on-1s](1on1s) +- [Performance](performance) diff --git a/docs/employees/performance.md b/docs/company/employees/performance.md similarity index 100% rename from docs/employees/performance.md rename to docs/company/employees/performance.md diff --git a/docs/company/goals/june2023.md b/docs/company/goals/june2023.md index 0e81ca7..fd8bb10 100644 --- a/docs/company/goals/june2023.md +++ b/docs/company/goals/june2023.md @@ -16,7 +16,7 @@ These are the goals Dave set for June, along with commentary regarding how we di * done - ongoing effort, no videos yet, taking shape as a useful resource 3. Post a demo video showing the benefits of KSD, setting up one of the use cases * done - was not able to do this; lack of a demo environment => project to set up demo environment -4. See the [strategy for adoption](../marketing/strategy-for-adoption) +4. See the [strategy for adoption](/marketing/strategy-for-adoption) * 50% - still could use better sign-up, account creation to make people feel welcome, like we are legit; also KSD lacking sufficient value to be worth trying diff --git a/docs/company/index.md b/docs/company/index.md index 5677c80..2eca1e4 100644 --- a/docs/company/index.md +++ b/docs/company/index.md @@ -1,14 +1,105 @@ -# Company +--- +title: About Koor +outline: [2, 3] +mermaidTheme: forest +--- -## About Koor +# About Koor -Koor is here to ease the burden on those who have the courage and smarts to manage their own data storage using Rook and Ceph. Koor is a start-up, and therefore must earn its right to exist by providing essential value to data storage professionals and hobbyists. +## What we do -If you like, please learn more about [Koor's mission](mission) or [vision](vision). Or you can peruse our [company goals](goals/). +Koor helps people who manage their own Ceph data storage. We develop and sell software that makes it easier to navigate the complexity of Rook and Ceph, to prevent problems, and to resolve issues when they occur. -To learn how we position and promote Koor's products and services, you can look through our [marketing](marketing/) materials. -- [Mission](mission.html) -- [Vision](vision.html) -- [Goals](goals/) -- [Marketing](marketing/) \ No newline at end of file +## Mission + +Koor's mission is to make self-managed Rook and Ceph data storage easier to use. We aspire to build expertise into our software products. We want Koor products to be the obvious choice for people who manage their own data storage systems. + +Koor is a start-up that must earn its right to exist. We believe in the opportunity to improve the experience of those who adopt open source. By making Ceph and Rook more accessible, we will help grow the open source community. Our relationship is symbiotic. + + +## Vision + +Imagine a future where Koor is one of a few dominant players in the data storage space. Koor serves the data management needs of customers, whether they want to control data themselves or have Koor handle it for them. Koor gives customers control over all types and uses of data storage. + +This is a big vision. Maybe too big. Let's accomplish this in stages from the beginning through the next 3 to 5 years. + + +### Mindmap of Company Vision + +```mermaid +mindmap + id(Koor Vision) + original ))Original(( + Starting phase + Heavy on consulting + now ))Now(( + Started June 2023 + Focus on KSD subscriptions + KSD feature growth + Support instead of consulting + future ))Future(( + KSD matures + Adoption expands + Becomes defacto solution for Rook Ceph + pinnacle ))Pinnacle(( + Managed storage for anyone + Provisioning + Security + Monitoring + Compliance standards + Managed storage software for IT departments +``` + + +### 1. Original Phase - Consulting + +Koor helps customers with Rook Ceph data storage through consulting engagements. We help customer with only Ceph, too. That is a reflection of what we are doing. + +***As of July 2023, we are moving to the next stage.*** + +### 2. Now - Koor Comes of Age + +Koor offers subscriptions to the Data Control Center: + +* Free trial - up to 4 nodes with limited support. +* Pro - 4+ nodes with unlimited support, include an initial system assessment. +* Enterprise - for bulk discounts and optional labor-intensive support programs, which come for an additional cost. + +Coming of age means that we have found customers who see the value of what we have to offer and made the effort to adopt our solution. When we are adding a dozen or more customers per week, that will be able to accelerate to the next phase. + + +### 3. Future - Koor is the Solution of Choice + +The Koor Data Control Center (KDCC) has enough useful features to merit higher subscription prices. Expertise is built into the product and easy to apply. Support is still unlimited but relied on less and less as KSD becomes more useful. KDCC is the go-to add-on software for anyone running Rook Ceph. + + +### 4. Pianncle - Koor offers self-service data storage + +Koor uses KDCC to run data storage on behalf of customers who want to outsource the effort. Customer can take over whenever they like without surprises or having to migrate data. The same controls can be operated by a customer's IT staff. + +The software automates self-service provisioning by authorized users. It also provides NOC-style operational controls and handles all types of administration and maintenance. The solution is certified for various levels of regulatory compliance. + + +## History of the company + +Koor was born on 18 March 2022. The Alexander Trost was the founding engineer. Over the next year, Alexander assembled a team of data storage experts: Gaurav, Deepika, Zuhair, and Javier. At some point Gaurav left. In April 2023, Dave Mount agreed to join. He started as CTO on May 8. + +Koor has attracted a dozen or so customers who needed help with their data storage. Some only use Ceph and some use both Rook and Ceph. The Koor Storage Distribution (KSD) was the sole product offering for a while. One customer subscribed to a KSD Pro license in June 2023. + +During the summer of 2023, Koor started working on the Data Control Center. The idea is to materialize the "data control plane" into a GUI with a backing microservice that interacts on the user's behalf with Kubernetes and Ceph. This is a work in progress. + +The rest is yet to come. + +## Open source stewardship statement + +We love open source. In fact, Koor is one of the maintainers of the [Rook](https://rook.io) project. The Koor team contributes by picking up and resolving issues. + + +## And more… + +[Culture](culture) +[Communication](communication) +[Operating Procedures](operating-procedures) +[Goals](goals/) +[Employees](employees/) diff --git a/docs/company/mission.md b/docs/company/mission.md deleted file mode 100644 index 36f89a0..0000000 --- a/docs/company/mission.md +++ /dev/null @@ -1,3 +0,0 @@ -# Mission - -Share the joy of data management using Rook over Ceph storage. diff --git a/docs/company/operating-procedures.md b/docs/company/operating-procedures.md new file mode 100644 index 0000000..2a2ff08 --- /dev/null +++ b/docs/company/operating-procedures.md @@ -0,0 +1,18 @@ +--- +title: Operating Procedures +--- + +# Operating Procedures + +## Policies + + +## Code of Conduct + + +## Company goal setting + + +## Spending company money + + diff --git a/docs/company/vision.md b/docs/company/vision.md deleted file mode 100644 index 794cf98..0000000 --- a/docs/company/vision.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Vision for Koor Technologies, Inc. -mermaidTheme: forest ---- - -# Vision - -Imagine a future where Koor is one of a few dominant players in the data storage space. Koor serves the data management needs of customers, whether they want to control data themselves or have Koor handle it for them. Koor gives customers control over all types and uses of data storage. - -This is a big vision. Maybe too big. Let's accomplish this in stages from the beginning through the next 3 to 5 years. - - -## Mindmap of Company Vision - -```mermaid -mindmap - id(Koor Vision) - original ))Original(( - Starting phase - Heavy on consulting - now ))Now(( - Started June 2023 - Focus on KSD subscriptions - KSD feature growth - Support instead of consulting - future ))Future(( - KSD matures - Adoption expands - Becomes defacto solution for Rook Ceph - pinnacle ))Pinnacle(( - Managed storage for anyone - Provisioning - Security - Monitoring - Compliance standards - Managed storage software for IT departments -``` - - -## Original - Consulting - -Koor helps customers with Rook Ceph data storage through consulting engagements. We help customer with only Ceph, too. That is a reflection of what we are doing. - -*As of July 2023, we are phasing out this approach in favor of the next stage.* - -## Now - KSD Comes of Age - -Koor offers KSD subscriptions: Trial (up to 4 nodes with limited support), Pro, and Enterprise. With a Pro or Enterprise subscription, customers get unlimited support with their Rook Ceph data storage. Enterprise customer have enough volume to merit discounts. The KSD is licensed per node. - -## Future - KSD is the Solution of Choice - -KSD has enough useful features to match or exceed to subscription price. Expertise is built into the product. Support is still unlimited but relied on less and less as KSD becomes more useful. KSD is the go-to add-on software for anyone running Rook Ceph. - -## Pianncle - Koor offers self-service data storage - -Koor uses KSD and our team of experts to run data storage for customers who would like to outsource. The advantage of using Koor is that it is Rook Ceph. The customer can take over whenever they like. We also offer the tools for enterprise customers to manage data self-service for their internal users. - diff --git a/docs/customers/index.md b/docs/customers/index.md new file mode 100644 index 0000000..f39f8d1 --- /dev/null +++ b/docs/customers/index.md @@ -0,0 +1,14 @@ +--- +title: Customer Success +--- + +# Customer Success + +## New customer onboarding + +## Customer meetings + +## Customer requests + +## Customer codenames + diff --git a/docs/consulting/assessments.md b/docs/customers/support/assessments.md similarity index 100% rename from docs/consulting/assessments.md rename to docs/customers/support/assessments.md diff --git a/docs/consulting/customer-calls.md b/docs/customers/support/customer-calls.md similarity index 100% rename from docs/consulting/customer-calls.md rename to docs/customers/support/customer-calls.md diff --git a/docs/consulting/index.md b/docs/customers/support/index.md similarity index 100% rename from docs/consulting/index.md rename to docs/customers/support/index.md diff --git a/docs/consulting/keeping-in-touch.md b/docs/customers/support/keeping-in-touch.md similarity index 100% rename from docs/consulting/keeping-in-touch.md rename to docs/customers/support/keeping-in-touch.md diff --git a/docs/consulting/performance-tuning.md b/docs/customers/support/performance-tuning.md similarity index 100% rename from docs/consulting/performance-tuning.md rename to docs/customers/support/performance-tuning.md diff --git a/docs/consulting/tracking.md b/docs/customers/support/tracking.md similarity index 100% rename from docs/consulting/tracking.md rename to docs/customers/support/tracking.md diff --git a/docs/consulting/troubleshooting.md b/docs/customers/support/troubleshooting.md similarity index 100% rename from docs/consulting/troubleshooting.md rename to docs/customers/support/troubleshooting.md diff --git a/docs/development/demo/demo-system-design.drawio.svg b/docs/engineering/demo/demo-system-design.drawio.svg similarity index 100% rename from docs/development/demo/demo-system-design.drawio.svg rename to docs/engineering/demo/demo-system-design.drawio.svg diff --git a/docs/development/demo/demo-system-mindmap.md b/docs/engineering/demo/demo-system-mindmap.md similarity index 100% rename from docs/development/demo/demo-system-mindmap.md rename to docs/engineering/demo/demo-system-mindmap.md diff --git a/docs/development/demo/impl-notes-take-1.md b/docs/engineering/demo/impl-notes-take-1.md similarity index 100% rename from docs/development/demo/impl-notes-take-1.md rename to docs/engineering/demo/impl-notes-take-1.md diff --git a/docs/development/demo/index.md b/docs/engineering/demo/index.md similarity index 100% rename from docs/development/demo/index.md rename to docs/engineering/demo/index.md diff --git a/docs/development/index.md b/docs/engineering/development/index.md similarity index 99% rename from docs/development/index.md rename to docs/engineering/development/index.md index 7536468..ed7fd61 100644 --- a/docs/development/index.md +++ b/docs/engineering/development/index.md @@ -1,5 +1,6 @@ --- title: Koor Software Development +outline: [2, 3] --- # Development Practices diff --git a/docs/development/infrastructure.md b/docs/engineering/development/infrastructure.md similarity index 100% rename from docs/development/infrastructure.md rename to docs/engineering/development/infrastructure.md diff --git a/docs/engineering/development/release-checklist.md b/docs/engineering/development/release-checklist.md new file mode 100644 index 0000000..8ae9e5a --- /dev/null +++ b/docs/engineering/development/release-checklist.md @@ -0,0 +1,22 @@ +--- +title: Release Checklist +--- + +# Release Checklist + +## General Procedure + +For each release, copy the steps from [the template](https://linear.app/koorinc/document/release-checklist-b1af1d958c94) attached to the "Productization" project in Linear into a new Linear issue. Check off tasks as you finish them. Use sub-tasks if needed - or just put a name on each line of the checklist. + +If you notice a step that is not listed, add it to the checklist. Also, add it to the template in Linear, or at least create a separate issue to add the step to the template later. + +## Checklist Structure + +This is the high-level structure of the release process. The [template in Linear](https://linear.app/koorinc/document/release-checklist-b1af1d958c94) is the official checklist that includes all of the details. + +- Sync with the latest upstream Rook release +- Build the latest versions of our sub-systems +- Write release notes +- Test the release +- Distribute release +- Announce the release diff --git a/docs/development/release-management.md b/docs/engineering/development/release-management.md similarity index 99% rename from docs/development/release-management.md rename to docs/engineering/development/release-management.md index 176c39c..2cbb2f6 100644 --- a/docs/development/release-management.md +++ b/docs/engineering/development/release-management.md @@ -1,5 +1,6 @@ --- title: Release Management +outline: [2, 3] --- # KSD Release Management diff --git a/docs/engineering/index.md b/docs/engineering/index.md new file mode 100644 index 0000000..3bbff10 --- /dev/null +++ b/docs/engineering/index.md @@ -0,0 +1,17 @@ +--- +title: Engineering +--- + +# Engineering + +## Dev cycle (a.k.a. sprint) planning +## Release process +## Oncall rotation +## Outages +## Incident postmortem + +[Development](development/) +[Demo](demo/) +[Product Planning](product/) +[Quality](quality/) +[System Operations](systemops/) diff --git a/docs/engineering/product/index.md b/docs/engineering/product/index.md new file mode 100644 index 0000000..3fdb229 --- /dev/null +++ b/docs/engineering/product/index.md @@ -0,0 +1,16 @@ +--- +title: Product +--- + +# Product + +## Planning, prioritization, and process + +[Roadmap](product-roadmap) + +## Managing requests +## Releases +## Beta features +## Feature flags +## UI design +## Usage statistics diff --git a/docs/development/product-roadmap.md b/docs/engineering/product/product-roadmap.md similarity index 98% rename from docs/development/product-roadmap.md rename to docs/engineering/product/product-roadmap.md index 617b1a4..cd20673 100644 --- a/docs/development/product-roadmap.md +++ b/docs/engineering/product/product-roadmap.md @@ -1,5 +1,6 @@ --- title: Product Roadmap +outline: [2, 3] --- # Product Roadmap @@ -33,7 +34,7 @@ The real problem with what we have offered so far is that have had zero adoption Our customers to date are those who sought help with issues using Rook and Ceph. We are able to resolve issues and recommend improvements, so that has worked out. We need a much larger customer base, and we need customers to use our products. -## Next +## Next - Koor Data Control Center Our new product strategy is to offer a single, multi-faceted product. For now as a working title, let's call it the Koor Data Control Center (KDCC). That's what we are building and offering, even though we may try different names in our marketing and sales packaging. diff --git a/docs/engineering/quality/index.md b/docs/engineering/quality/index.md new file mode 100644 index 0000000..42acf64 --- /dev/null +++ b/docs/engineering/quality/index.md @@ -0,0 +1,8 @@ +--- +title: Quality +--- + +# Quality + +## Testing practices +## Release forensics diff --git a/docs/engineering/systemops/index.md b/docs/engineering/systemops/index.md new file mode 100644 index 0000000..46b6ddc --- /dev/null +++ b/docs/engineering/systemops/index.md @@ -0,0 +1,12 @@ +--- +title: System Operations +--- + +# System Operations + +## Hosting / provisioning +## System health +## Monitoring +## Outage protocols +## Security +## Networks diff --git a/docs/index.md b/docs/index.md index f2417c3..4fcc43c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,8 +3,8 @@ layout: home hero: - name: Operating Handbook for Koor Technologies, Inc. - text: How we run our business + name: Koor Handbook + text: Minding our business tagline: Compounding daily, incremental improvements to build something amazing image: src: /koor-logo.png @@ -14,14 +14,11 @@ hero: text: Company Goals link: /company/goals/ - theme: alt - text: Employees - link: /employees/ - - theme: alt - text: Support Practices - link: /consulting/ + text: Product Roadmap + link: /engineering/product/product-roadmap - theme: alt text: Demo System - link: /development/demo/ + link: /engineering/demo/ features: - title: Company @@ -30,14 +27,14 @@ features: linkText: What makes us tick - title: Employees details: All about our people - link: /employees/ + link: /company/employees/ linkText: Who we are - title: Development - details: How we build great software and contribute to the Rook Ceph open source community - link: /development/ + details: How we build great software + link: /engineering/development/ linkText: What we build - - title: Consulting / Support + - title: Customer Support details: Service we provide to customers in need - link: /consulting/ + link: /customers/support/ linkText: How we help --- diff --git a/docs/company/marketing/branding.md b/docs/marketing/branding.md similarity index 100% rename from docs/company/marketing/branding.md rename to docs/marketing/branding.md diff --git a/docs/company/marketing/index.md b/docs/marketing/index.md similarity index 100% rename from docs/company/marketing/index.md rename to docs/marketing/index.md diff --git a/docs/company/marketing/social-media.md b/docs/marketing/social-media.md similarity index 88% rename from docs/company/marketing/social-media.md rename to docs/marketing/social-media.md index c13c8b8..e51ea09 100644 --- a/docs/company/marketing/social-media.md +++ b/docs/marketing/social-media.md @@ -4,12 +4,12 @@ title: Social Media # Social Media -## Where ee post +## Where we post These are the social media sites we post to. * Hacker News - * [new posts](https://news.ycombinator.com/submit) + * [new posts](https://news.ycombinator.com/submit) - unless your name is Dave, in which case they will shadow-ban you for talking too much about data * To observe trends: [Hakaran](https://www.hakaran.com/) * Sorted, filtered: [Hckr News](https://hckrnews.com/) * Twitter diff --git a/docs/company/marketing/strategy-for-adoption.md b/docs/marketing/strategy-for-adoption.md similarity index 100% rename from docs/company/marketing/strategy-for-adoption.md rename to docs/marketing/strategy-for-adoption.md diff --git a/docs/sales/index.md b/docs/sales/index.md new file mode 100644 index 0000000..356960c --- /dev/null +++ b/docs/sales/index.md @@ -0,0 +1,8 @@ +--- +title: Sales +--- + +# Sales + +## Targets +## Bonus plan diff --git a/docs/security/index.md b/docs/security/index.md new file mode 100644 index 0000000..ace297a --- /dev/null +++ b/docs/security/index.md @@ -0,0 +1,11 @@ +--- +title: Security +--- + +# Security + +## Policies +## Account recovery +## System access +## Vulnerability management +## Badges (just kidding)