docs: include github packages instructions (redhat-developer#234)

* docs: include github packages instructions * Update build_docs/building.adoc Co-authored-by: Wojciech Trocki <[email protected]> Co-authored-by: Wojciech Trocki <[email protected]>
andreaTP · Jun 17, 2021 · fad50fa · fad50fa
1 parent 668a242
commit fad50fa
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/build_docs/building.adoc b/build_docs/building.adoc
@@ -4,7 +4,11 @@
  - mvn
  - OpenShift Client (or kubernetes)
 
-= Building and Devloping
+= GitHub Packages Setup
+
+This project uses GitHub packages for of its dependencies. Before you can build this project using `mvn install` you must configure Maven to authenticate to GitHub with a Personal Access Token that has packages:read permission.   Please refer to [link:https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry[GitHub's documentation] fordetailed instructions.
+
+= Building and Developing
 
 The operator is written in Java as a multi module Maven project. The easiest way to build and run the operator locally is 
 
@@ -24,4 +28,4 @@ link:https://github.com/bf2fc6cc711aee1a0c2a/operator/tree/main/olm/olm-template
 
 == Operator Container Build
 
-The Operator container is built by link:https://quarkus.io/guides/container-image[Quarkus JIB]. The configuration is provided by link:https://github.com/bf2fc6cc711aee1a0c2a/operator/blob/main/source/rhoas/src/main/resources/application.properties[application.properties]. The link:https://github.com/bf2fc6cc711aee1a0c2a/operator/blob/main/.github/workflows/release.yml#L32[GitHub action release workflow] contains an example of these values being overidden to release the operator. 
+The Operator container is built by link:https://quarkus.io/guides/container-image[Quarkus JIB]. The configuration is provided by link:https://github.com/bf2fc6cc711aee1a0c2a/operator/blob/main/source/rhoas/src/main/resources/application.properties[application.properties]. The link:https://github.com/bf2fc6cc711aee1a0c2a/operator/blob/main/.github/workflows/release.yml#L32[GitHub action release workflow] contains an example of these values being overidden to release the operator.