[Fix/Documentation] Getting started

CHANGELOG.md

@@ -10,6 +10,8 @@
 
 ### Fixed Bugs
 
+- [PR #30](https://github.com/Orange-OpenSource/nifikop/pull/40) - [Documentation] Fix getting started
+
 ## v0.3.1-release
 
 ### Fixed Bugs

CONTRIBUTING.md

@@ -10,7 +10,7 @@ NiFiKop is Apache 2.0 licensed and accepts contributions via GitHub pull request
 ## Getting started
 
 - Fork the repository on GitHub
-- See the [developer guide](./doc/dev/developer_guide.md) for build instructions
+- See the [developer guide](https://orange-opensource.github.io/nifikop/docs/6_contributing/1_developer_guide) for build instructions
 
 ## Reporting bugs and creating issues
 

website/docs/2_setup/1_getting_started.md

@@ -126,13 +126,13 @@ Remember to set your NiFiCluster CR properly to use the newly created StorageCla
 kubectl create -n nifi -f config/samples/simplenificluster.yaml
 ```
 
-## Easy way: installing with Helm
+## Installing with Helm
 
-Alternatively, if you are using Helm, you can deploy the operator using a Helm chart [Helm chart](https://github.com/Orange-OpenSource/nifikop/tree/master/helm):
+You can deploy the operator using a Helm chart [Helm chart](https://github.com/Orange-OpenSource/nifikop/tree/master/helm):
 
-> To install the an other version of the operator use `helm install --name=nifikop --namespace=nifi --set operator.image.tag=x.y.z orange-incubator/nifikop`
+> To install  an other version of the operator use `helm install --name=nifikop --namespace=nifi --set operator.image.tag=x.y.z orange-incubator/nifikop`
 
-Deploy the NiFiKop crds : 
+First, eploy the NiFiKop crds : 
 
 <Tabs
   defaultValue="k8s16+"
@@ -144,8 +144,11 @@ Deploy the NiFiKop crds :
 <TabItem value="k8s16+">
 
 ```bash
-kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/nifi.orange.com_nificlusters_crd.yaml
-kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/nifi.orange.com_nifiusers_crd.yaml
+kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1/nifi.orange.com_nificlusters_crd.yaml
+kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1/nifi.orange.com_nifiusers_crd.yaml
+kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1/nifi.orange.com_nifidataflows_crd.yaml
+kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1/nifi.orange.com_nifiparametercontexts_crd.yaml
+kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1/nifi.orange.com_nifiregistryclients_crd.yaml
 ```
 
 </TabItem>
@@ -154,6 +157,9 @@ kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/mas
 ```bash
 kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1beta1/nifi.orange.com_nificlusters_crd.yaml
 kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1beta1/nifi.orange.com_nifiusers_crd.yaml
+kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1beta1/nifi.orange.com_nifidataflows_crd.yaml
+kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1beta1/nifi.orange.com_nifiparametercontexts_crd.yaml
+kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/nifikop/master/deploy/crds/v1beta1/nifi.orange.com_nifiregistryclients_crd.yaml
 ```
 </TabItem>
 </Tabs>

website/docs/3_tasks/3_nifi_dataflow.md

@@ -112,6 +112,7 @@ To find details about the versioned flow information required check the [officia
 You have two modes of control from your dataflow by the operator : 
 
 1 - `Spec.RunOnce == true` : The operator will deploy the dataflow as described in the resource, run it once, and never control it again (unless you change the field to `false`). It is useful when you want to deploy your dataflow in a dev environment, and you want to update the dataflow.
+
 2 - `Spec.RunOnce == true` : The operator will deploy and ensure the dataflow lifecycle, it will avoid all manual modification directly from the Cluster (e.g remove the process group, remove the versioning, update the parent process group, make some local changes ...). If you want to perform update, rollback or stuff like this, you have to simply update the [NifiDataflow] resource.
 
 :::info

website/docs/6_contributing/1_developer_guide.md

@@ -52,7 +52,7 @@ make build
 
 #### Cross platform build environment
 
-Build the docker image which will be used to build CassKop docker image
+Build the docker image which will be used to build NiFiKop docker image
 
 ```bash
 make build-ci-image
@@ -95,13 +95,17 @@ This method can be used to run the operator locally outside of the cluster. This
 Set the name of the operator in an environment variable
 
 ```bash
- export OPERATOR_NAME=cassandra-operator
+ export OPERATOR_NAME=nifi-operator
 ```
 
-Deploy the CRD.
+Deploy the CRDs.
 
 ```bash
 kubectl apply -f deploy/crds/nifi.orange.com_nificlusters_crd.yaml
+kubectl apply -f deploy/crds/nifi.orange.com_nifidataflows_crd.yaml
+kubectl apply -f deploy/crds/nifi.orange.com_nifiparametercontexts_crd.yaml
+kubectl apply -f deploy/crds/nifi.orange.com_nifiregistryclients_crd.yaml
+kubectl apply -f deploy/crds/nifi.orange.com_nifiusers_crd.yaml
 ```
 
 And deploy the operator.