Minor updates - add links, delete outdated instructions

Signed-off-by: Michael Edgar <[email protected]>

CONTRIBUTING.md

@@ -17,7 +17,7 @@ The DCO text is also included verbatim in the [dco.txt](dco.txt) file in the roo
 
 ## Reporting an issue
 
-This project uses GitHub issues to manage the issues. Open an issue directly in GitHub. you can also open JIRA issues at https://issues.redhat.com/browse/MGDSTRM
+This project uses GitHub issues to manage the issues. Open an issue directly in GitHub.
 
 If you believe you found a bug, and it's likely possible, please indicate a way to reproduce it, what you are seeing and what you would expect to see.
 

README.md

@@ -1,18 +1,18 @@
 # Console for Apache Kafka™ on Kubernetes
 
-This project is a web console designed to facilitate interactions with Apache Kafka™ instances on Kubernetes, leveraging the [Strimzi](https://strimzi.io) Cluster Operator. 
-It is composed of two main parts: 
+This project is a web console designed to facilitate interactions with Apache Kafka™ instances on Kubernetes, leveraging the [Strimzi](https://strimzi.io) Cluster Operator.
+It is composed of two main parts:
 
-- a REST API backend developed with Java Quarkus
-- a user interface (UI) built with Next.js and [PatternFly](https://patternfly.org)
+- a REST API backend developed with Java and [Quarkus](https://quarkus.io/)
+- a user interface (UI) built with [Next.js](https://nextjs.org/) and [PatternFly](https://patternfly.org)
 
 ## Installing
 
-Please refer to the [install/README.md](./install/README.md) file for detailed information about how to install the Console.
+Please refer to the [installation README](./install/README.md) file for detailed information about how to install the latest release of the console in a Kubernetes cluster.
 
 ## Contributing
 
-We welcome contributions of all forms. Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file for how to get started. 
+We welcome contributions of all forms. Please see the [CONTRIBUTING](./CONTRIBUTING.md) file for how to get started.
 Join us in enhancing the capabilities of this console for Apache Kafka™ on Kubernetes.
 
 ## License

api/CONTRIBUTING.md

@@ -6,7 +6,7 @@ Please check the project's [contributing guide](../CONTRIBUTING.md) first.
 
 ## Prerequisites
 
-Ensure you have Kubernetes and Strimzi Cluster Operator installed on your system.
+Ensure you have Kubernetes and Strimzi Cluster Operator installed on your system. Either [minikube](https://minikube.sigs.k8s.io/) or [OpenShifot Local](https://developers.redhat.com/products/openshift-local) are good options.
 One option to get started is to follow [Strimzi's Quick Starts](https://strimzi.io/quickstarts/).
 
 You will also need a working installation of:
@@ -21,60 +21,13 @@ You will also need a working installation of:
 
 ### Continuous Integration
 
- kafka-admin-api CI is based on GitHub Actions, which means that everyone has the ability to automatically execute CI in their forks as part of the process of making changes. We ask that all non-trivial changes go through this process, so that the contributor gets immediate feedback, while at the same time keeping our CI fast and healthy for everyone.
+This project's CI is based on GitHub Actions, which means that everyone has the ability to automatically execute CI in their forks as part of the process of making changes. We ask that all non-trivial changes go through this process, so that the contributor gets immediate feedback, while at the same time keeping our CI fast and healthy for everyone.
 
 ### Tests and documentation are not optional
 
-Don't forget to include tests in your pull requests.
-Also don't forget the documentation (reference documentation, javadoc...).
+Do not forget to include or update tests in your pull requests and update any related documentation (reference documentation, javadoc...).
 
 ### Installing Checkstyle
 
-Project uses checkstyle mvn plugin that is executed during `mvn validate` pase.
-Please follow your ide setup for checkstyle. For example for intelij:
-
-https://plugins.jetbrains.com/plugin/1065-checkstyle-idea
-
-## Regenerating OpenAPI file
-
-PRs that make changes in the API should update openapi file by executing:
-
-```
-mvn -Popenapi-generate process-classes
-```
-
-Please commit generated files along with the PR for review.
-
-### Interacting with local kafka
-
-1. Creating topic
-
-Use the `kafka-topics.sh` tool to manage topics. kafka-topics.sh is part of the [Apache Kafka distribution](https://kafka.apache.org/downloads) and is found in the bin directory.
-
-```
-kafka-topics.sh --create --bootstrap-server localhost:9092  --partitions=3 --replication-factor=1 --topic test --command-config ./hack/binscripts.properties
-```
-
-2. Produce messages using kcat
-
-Use [`kcat`](https://github.com/edenhill/kcat) to produce messages. 
-
-```
-kcat -b localhost:9092 -F ./hack/kcat.properties -P -t test
-```
-
-
-4. Consume messages
-
-Use [`kcat`](https://github.com/edenhill/kcat) to consume messages.
-
-```
-kcat -b localhost:9092 -F ./hack/kcat.properties  -C -t test
-```
-
-6. Interact with the API to view results
-
-`
-curl -s -u admin:admin-secret http://localhost:8080/api/v1/consumer-groups | jq
-`
-
+Project uses checkstyle mvn plugin that is executed during `mvn validate` phase. Make sure to verify this
+passes before pushing to Github.

ui/CONTRIBUTING.md

@@ -37,7 +37,7 @@ npm run build
 npm run start
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the console.
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the console user interface.
 
 ## Build
 
@@ -97,4 +97,4 @@ npm run build
 npm run test
 ```
 
-This will run Playwright against a production build of the application. 
+This will run Playwright against the built application.