(doc-site) Remove PRD from doc site

Also order docs in the Tasks folder using 'nav' in mkdocs.yml Signed-off-by: Anik <anikbhattacharya93@gmail.com>
operator-framework · Aug 8, 2023 · 6b596d4 · 6b596d4
1 parent 949c06a
commit 6b596d4
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 29 deletions.
diff --git a/docs/Tasks/adding-a-catalog.md b/docs/Tasks/adding-a-catalog.md
@@ -1,10 +1,3 @@
----
-layout: default
-title: Adding a catalog of operators to the cluster
-nav_order: 1
-parent: Tasks
----
-
 Operator authors have the mechanisms to offer their product as part of a curated catalog of operators, that they can push updates to over-the-air (eg publish new versions, publish patched versions with CVEs, etc). Cluster admins can sign up to receive these updates on clusters, by adding the catalog to the cluster. When a catalog is added to a cluster, the kubernetes extension packages (operators, or any other extension package) in that catalog become available on cluster for installation and receiving updates.  
 
 For example, the [k8s-operatorhub/community-operators](https://github.com/k8s-operatorhub/community-operators) is a catalog of curated operators that contains a list of operators being developed by the community. The list of operators can be viewed in [Operatorhub.io](https://operatorhub.io). This catalog is distributed as an image [quay.io/operatorhubio/catalog](https://quay.io/repository/operatorhubio/catalog?tag=latest&tab=tags) for consumption on clusters. 

diff --git a/docs/Tasks/explore-available-packages.md b/docs/Tasks/explore-available-packages.md
@@ -1,10 +1,3 @@
----
-layout: default
-title: Exploring packages available for installation on cluster
-nav_order: 2
-parent: Tasks
----
-
 The packages available for installation/receiving updates on cluster can be explored by querying the `Package` and `BundleMetadata` CRs: 
 
 ```bash

diff --git a/docs/Tasks/installing-an-operator.md b/docs/Tasks/installing-an-operator.md
@@ -1,10 +1,3 @@
----
-layout: default
-title: Installing an operator on cluster
-nav_order: 3
-parent: Tasks
----
-
 Creating an Operator CR installs the operator on cluster:  
 
 ```bash

diff --git a/docs/Tasks/deleting-an-operator.md → docs/Tasks/uninstall-an-operator.md b/docs/Tasks/deleting-an-operator.md → docs/Tasks/uninstall-an-operator.md
@@ -1,11 +1,4 @@
----
-layout: default
-title: Deleting an operator from the cluster
-nav_order: 4
-parent: Tasks
----
-
-Deleting an operator is as simple as deleting an existing Operator CR: 
+Uninstalling an operator is as simple as deleting an existing Operator CR: 
 
 ```bash
 $ kubectl get operators 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,3 +6,11 @@ theme:
 
 repo_url: https://github.com/operator-framework/operator-controller
 
+nav: 
+  - Home: 'index.md'
+  - Components: 'components.md'
+  - Tasks: 
+    - Adding a catalog of operators: 'adding-a-catalog.md'
+    - Explore operators available for installation: 'explore-available-packages.md'
+    - Installing an operator: 'installing-an-operator.md'
+    - Deleting an operator: 'deleting-an-operator.md'
diff --git a/docs/olmv1_roadmap.md → olmv1_roadmap.md b/docs/olmv1_roadmap.md → olmv1_roadmap.md