Merge pull request #20 from oslabs-beta/brisa_README_cleanup

Brisa README cleanup

Author: LucieSeidler

CONTRIBUTING.md

@@ -14,19 +14,24 @@ Chronos welcomes all pull requests.
 6. Create a pull request to `master`.
 
 ## Getting started
-- `npm run bot`: Run Node and Electron at the same time to start Chronos app
-  - To make changes to codebase on the Main Process
+- `npm run dev:app` and `npm run dev:electron`: Run Node and Electron at the same time to start Chronos app
+  - To make changes to codebase on the Main Process:
     - Files in the main process must be compiled prior to starting the app
-      - In the terminal un Chronos directory, input `tsc` to comile typescript files
-      - Once compiled, `npm run both`
-      * Note** If typescript is not installed, `npm install -g typescript` 
+      - In the terminal in Chronos directory, input `tsc` to compile typescript files
+      - Once compiled, `npm run dev:app` and `npm run dev:electron`
+      * Note: If typescript is not installed, `npm install -g typescript` 
 
+## Chronos Website
+
+The `chronosWebsite` branch holds the code for the website. Edit the website by checking out the branch, modifying the website, and then updating the AWS S3 bucket with the changes.
 ## Issues
 
-Please do not hesitate to file issues. Chronos is based off of community feedback and is  always looking for ways to get better. The team behind Chronos is interested to hear about your experience and how we can improve it.
+Please do not hesitate to file issues that detail bugs or offer ways to enhace Chronos.
+
+Chronos is based off of community feedback and is  always looking for ways to get better. The team behind Chronos is interested to hear about your experience and how we can improve it.
 
-Please do not hesitate to submit issues that promote bugs or offer ways to enhance to Chronos. When submitting issues, ensure your description is clear and has instructions to be able to reproduce the issue.
+When submitting issues, ensure your description is clear and has instructions to be able to reproduce the issue.
 
-## Get in touch
+## Get In Touch
 
-We use GitHub as a platform of communication between users and developers to promote transparency. We thrive off of the community support and feedback
+We use GitHub as a platform of communication between users and developers to promote transparency, community support and feedback.

README.md

@@ -5,7 +5,6 @@
 1. React Testing Library versions 13+ require React v18. If your project uses an older version of React, be sure to install version 12
 ```
 npm install --save-dev @testing-library/react@12
-
 ``` 
 2. install additional packages
 ```
@@ -55,12 +54,9 @@ module.exports = {
 
 6. use `npm run test` to run jest tests
 
-### Contributing
+## Contributing
 
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
-### People
-[Snow X. Bai](https://github.com/xueapp)
-[Taylor Zhang](https://github.com/taylrzhang)
-[Tim Lee](https://github.com/timlee12)
-[Roberto Meloni](https://github.com/RobertoRueMeloni)
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
+

__tests__/README.md

@@ -1,18 +1,7 @@
-# Chronos
-Visit our splash page at [chronoslany.com](https://chronoslany.com/)
-
-Chronos is a comprehensive developer tool that monitors the health and web traffic of servers, microservices, and containers. Use Chronos to see real-time data monitoring and receive automated notifications over Slack or email.
-
-#
-
 ## What's New?
 - Bug Fixes
-- Metric query tool so you can filter out specific metrics — now you only have to see what you want on the dashboard.
-- Additional metrics added, bringing Chronos up from only 12 to 100+ metrics that are currently available
-- Option to filter by category and individual metric, and flip between services and categories with ease
-- Kubernetes monitoring via Prometheus server
-- Apache Kafka monitoring capability, all you need to do is run Prometheus JMX exporter on the system your Chronos application is running on. A sample JMX config.yaml file is provided in the Chronos repository for a quick and easy setup, however you are free to configure however you like.
-
+- Refactored code for additional modularity and customization
+- Ability for developers to increase number of metrics monitored for microservices
 #
 
 ## Features 
@@ -35,7 +24,6 @@ Install the package as a dependency in each of the microservices you want to tra
 npm install @chronosmicro/tracker
 ```
 
-<br>
 
 ### Configuring Chronos Tracker
 Create a `.js` Chronos configuration file (hereby referred to as `chronos-config.js`), which exports a JavaScript object with required Chronos configuration parameters. This object will be used as the sole Chronos class constructor argument. Feel free to use a `.env` file to hold sensitive parameters like the database URI, for example.
@@ -75,21 +63,20 @@ module.exports = {
 }
 ```
 
-Then utilize the `chronos-config.js` file into your microservice application by importing it and using it as the Chronos class constructor argument:
+Then utilize the `chronos-config.js` file into your application by importing it and using it as the Chronos class constructor argument:
 ```js
 const chronosConfig = require('./chronos-config.js');
 const Chronos = require('@chronosmicro/tracker');
 const chronos = new Chronos(chronosConfig);
 ```
 
-<br>
 
 #### Chronos Configuration Parameters
 _See mode-specific configuration descriptions in the "Chronos Tracker for Microservices" section_
 
 The `microservice` property takes in a string. This should be a descriptive name for your microservice.
 
-- <img src="assets/important.png" alt="Important" title="Important" align="center" height="20" /> For **Dockerized** microservices, this field **must** match the _container_name_ of the corresponding Docker container.
+- <img src="../assets/important.png" alt="Important" title="Important" align="center" height="20" /> For **Dockerized** microservices, this field **must** match the _container_name_ of the corresponding Docker container.
 
 The `interval` property is optional and takes in an integer. This controls the Chronos monitoring frequency. If this is omitted, Chronos will default to recording server health every 60000 ms or 60 seconds.
 
@@ -144,14 +131,13 @@ Chronos provides the option to send  emails. The properties that should be provi
 - `user` - The email address (string) of the sender
 - `password` - The password (string) of the sender email
 
-_NOTE: Email notification settings may require alternative security settings to work_
 
-<br>
+**NOTE: Email notification settings may require alternative security settings to work**
 
 ### Chronos Tracker for "Microservices" Mode
 The mode `microservices` uses the additional setting `dockerized`, which indicates whether or not the microservice has been containerized with Docker. If omitted, Chronos will assume this server is not running in a container, i.e. `dockerized` will default to _false_. 
 
-Setting the flag to _false_ will collect metrics from the host computer directly, while _true_ indicates for Chronos to pull metrics from the Docker daemon.
+Setting the flag to `false` will collect metrics from the host computer directly, while `true` indicates for Chronos to pull metrics from the Docker daemon.
 
 ```js
 // Excerpt from a chronos-config.js
@@ -175,7 +161,9 @@ const chronos = new Chronos(chronosConfig);
 chronos.track()
 ```
 
-If you are using an Express.js REST API, calling `Chronos.track()` returns middleware that allows users to track incoming network requests and outgoing their corresponding outgoing responses by marking them with unique IDs using `Chronos.propagate`. If you want to utilize this feature, setup a catchall route that will serve as a pass through for tracking and chain in the middleware from `Chronos.track`.
+If you are using an Express.js REST API, calling `Chronos.track()` returns middleware that allows users to track incoming network requests and outgoing their corresponding outgoing responses by marking them with unique IDs using `Chronos.propagate`.
+
+If you want to utilize this feature, setup a catchall route that will serve as a pass through for tracking and chain in the middleware from `Chronos.track`.
 
 ```js
 const chronosConfig = require('./chronos-config.js');
@@ -211,7 +199,6 @@ If you're using `docker-compose` to start up multiple containers, you can add a
 volumes:
   - "/var/run/docker.sock:/var/run/docker.sock"
 ```
-<br>
 
 ### Chronos Tracker for "Kubernetes" Mode
 Chronos can monitor an Kubernetes clusters by saving metric data from instant queries to a Prometheus server in your Kubernetes cluster. 
@@ -241,7 +228,6 @@ const Chronos = require('@chronosmicro/tracker');
 const chronos = new Chronos(chronosConfig);
 
 chronos.kubernetes();
-
 ```
 
 
@@ -264,7 +250,7 @@ module.exports = {
 }
 ```
 
-Then, in ***ONE AND ONLY ONE** of your microservices, call `Chronos.kafka`: 
+Then, in **ONE AND ONLY ONE** of your microservices, call `Chronos.kafka`: 
 ```js
 const chronosConfig = require('./chronos-config.js');
 const Chronos = require('@chronosmicro/tracker');
@@ -279,7 +265,7 @@ When viewing your information in the Chronos Electron application the data will
 
 ### Chronos Tracker for gRPC
 
-To monitory your gRPC server, setup `chronos-config.js` as if it was a standard microservices example, but be sure to set the `connection` type to `gRPC`.
+To monitor your gRPC server, setup `chronos-config.js` as if it was a standard microservices example, but be sure to set the `connection` type to `gRPC`.
 
 ```js
 module.exports = {
@@ -400,14 +386,10 @@ chronos.link(client, ServerWrapper);
 ### Viewing Chronos Data
 Once you have configured and intialized Chronos Tracker, it will automatically record monitoring data when your servers are running. The data will be saved into your database of choice, and then start the Chronos desktop app to view by cloning our [GitHub repo](https://github.com/open-source-labs/Chronos). Folow the ReadMe in that repo to setup the Chronos desktop app. 
 
-<br>
 
 ## Examples
 
-We provide working example microservice applications in Chronos desktop app repo in the *examples* folder.
-[GitHub repo](https://github.com/open-source-labs/Chronos)
-
-#
+We provide working example microservice applications in Chronos desktop app repo in the [**examples**](../chronos_npm_package/README.md) folder.
 
 ## Technologies
 - Electron
@@ -424,18 +406,16 @@ We provide working example microservice applications in Chronos desktop app repo
 - Docker
 - Kubernetes
 
-#
 
 ## Contributing
 
-Development of Chronos is open source on GitHub through the tech accelerator umbrella OS Labs, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Chronos.
+Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
-[Contributing](https://github.com/oslabs-beta/Chronos/blob/master/CONTRIBUTING.md)
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
 
-#
 
 ## License
 
-Chronos is MIT licenced 
+[MIT](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
 #
 ###### Return to [Top](#chronos)

assets/examples_docker_data.png

@@ -128,7 +128,7 @@ mongo.health = async ({ microservice, interval, mode }) => {
 };
 
 /**
- * Runs instead of health if dockerized is true
+ * !Runs instead of health if dockerized is true
  * Collects information on the docker container
  */
 mongo.docker = ({ microservice, interval, mode }) => {

assets/examples_docker_removed.png

@@ -221,7 +221,7 @@ postgres.health = async ({ microservice, interval, mode }) => {
 };
 
 /**
- * Runs instead of health
+ * !Runs instead of health for docker
  * If dockerized is true, this function is invoked
  * Collects information on the container
  */

assets/examples_docker_stop.png

@@ -1,6 +1,6 @@
 {
   "name": "@chronosmicro/tracker",
-  "version": "8.0.3",
+  "version": "11.0.1",
   "description": "Chronos microservice metrics tracker",
   "main": "chronos.js",
   "scripts": {

assets/examples_enable_kubernetes_engine.png

@@ -0,0 +1,36 @@
+## People
+
+[Snow X. Bai](https://github.com/xueapp),
+[Taylor Zhang](https://github.com/taylrzhang),
+[Tim Lee](https://github.com/timlee12),
+[Roberto Meloni ](https://github.com/RobertoRueMeloni),
+[Brian Lim](https://github.com/brianlim89),
+[Claire Tischuk](https://github.com/BoopdiBop),
+[Lennon Stewart](https://github.com/noahoo7),
+[Victor Ye](https://github.com/vctorye),
+[Josh James](https://github.com/joshjames289),
+[Elise Nie](https://github.com/elisanie),
+[Gahl Peled](https://github.com/GP3-RS),
+[Troy Prejusa](https://github.com/tprejusa),
+[Vince Ho](https://github.com/hodesza)
+[Matt Jiang](https://github.com/mattljiang),
+[Derek Lam](https://github.com/DerekQuoc),
+[Kit Loong Yee](https://github.com/kitloong1),
+[Tim Atapagra](https://github.com/timpagra),
+[Mohtasim Chowdhury](https://github.com/mohtasim317),
+[Ousman Diallo](https://github.com/Dialloousman),
+[Michelle Herrera](https://github.com/mesherrera),
+[Duane McFarlane](https://github.com/Duane11003),
+[Ben Mizel](https://github.com/ben-mizel),
+[Jenae Pennie](https://github.com/jenaepen),
+[Chris Romano](https://github.com/robicano22),
+[Natalie Umanzor](https://github.com/nmczormick),
+[John Donato](https://github.com/jdonuto),
+[Iris Wong](https://github.com/wiris316),
+[Jon Cruz](https://github.com/Jrcrz),
+[Elena Atencio](https://github.com/elenaatencio),
+[Lucie Seidler](https://github.com/LucieSeidler),
+[Jeffrey Na](https://github.com/jeffreyNa),
+[Brisa Zhu](https://github.com/beezoo10),
+[Kelsi Webb](https://github.com/kelsicw),
+[Justin Poirier](https://github.com/jcpoirier20)

assets/examples_kubernetes_created.png

@@ -124,22 +124,10 @@ git archive -v -o myMM.zip --format=zip HEAD
 2. Select `cloud-based`
 
 3. Use Access Key, Secret Access Key, region, and EC2 instance ID to start monitoring EC2 instance. 
-
 ## Contributing
+
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
-## People
-[Snow X. Bai](https://github.com/xueapp)
-[Taylor Zhang](https://github.com/taylrzhang)
-[Tim Lee](https://github.com/timlee12)
-[Roberto Meloni ](https://github.com/RobertoRueMeloni)
-[Brian Lim](https://github.com/brianlim89)
-[Claire Tischuk](https://github.com/BoopdiBop)
-[Lennon Stewart](https://github.com/noahoo7)
-[Victor Ye](https://github.com/vctorye)
-[John Donato](https://github.com/jdonuto)
-[Iris Wong](https://github.com/wiris316)
-[Jon Cruz](https://github.com/Jrcrz)
-[Elena Atencio](https://github.com/elenaatencio)
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
 
 

assets/gRPC_example_reverseProxy.png

@@ -69,20 +69,8 @@ Step 7: Deploy test application in ECS
 ### Some notes about the ECS-test
 
 The way deployment set up is using Fargate, you will not be able to see graphs in ECS cluster->metrics. Instead, check inside services or Cloudwatch.
-
 ## Contributing
+
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
-## People
-[Snow X. Bai](https://github.com/xueapp)
-[Taylor Zhang](https://github.com/taylrzhang)
-[Tim Lee](https://github.com/timlee12)
-[Roberto Meloni ](https://github.com/RobertoRueMeloni)
-[Brian Lim](https://github.com/brianlim89)
-[Claire Tischuk](https://github.com/BoopdiBop)
-[Lennon Stewart](https://github.com/noahoo7)
-[Victor Ye](https://github.com/vctorye)
-[John Donato](https://github.com/jdonuto)
-[Iris Wong](https://github.com/wiris316)
-[Jon Cruz](https://github.com/Jrcrz)
-[Elena Atencio](https://github.com/elenaatencio)
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.

chronos_npm_package/README.md

@@ -160,13 +160,3 @@ This process can also be done using the AWS Command Line Interface (CLI) or the
 
 ## Credit
    Credit for Knote application goes to the user learnK8s on [Github](https://github.com/learnk8s).  Here is the source project [folder](https://github.com/learnk8s/knote-js/tree/master/04-05/kube). 
-
-## People
-[Brian Lim](https://github.com/brianlim89)
-[Claire Tischuk](https://github.com/BoopdiBop)
-[Lennon Stewart](https://github.com/noahoo7)
-[Victor Ye](https://github.com/vctorye)
-[John Donato](https://github.com/jdonuto)
-[Iris Wong](https://github.com/wiris316)
-[Jon Cruz](https://github.com/Jrcrz)
-[Elena Atencio](https://github.com/elenaatencio)