Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelog and README.md cleanup #1648

Merged
merged 7 commits into from Mar 24, 2021
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
102 changes: 51 additions & 51 deletions CHANGELOG

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions CODE_OF_CONDUCT.md
Expand Up @@ -17,10 +17,10 @@ This Code of Conduct makes our expectations of participants in this community ex
We expect participants in this community to conduct themselves professionally. Since our primary mode of communication is text on an online forum (e.g. issues, pull requests, comments, emails, or chats) devoid of vocal tone, gestures, or other context that is often vital to understanding, it is important that participants are attentive to their interaction style.

* **Assume positive intent.** We ask community members to assume positive intent on the part of other people’s communications. We may disagree on details, but we expect all suggestions to be supportive of the community goals.
* **Respect participants.** We expect participants will occasionally disagree. Even if we reject an idea, we welcome everyone’s participation. Open Source projects are learning experiences. Ask, explore, challenge, and then respectfully assert if you agree or disagree. If your idea is rejected, be more persuasive not bitter.
* **Respect participants.** We expect participants will occasionally disagree. Even if we reject an idea, we welcome everyone’s participation. Open Source projects are learning experiences. Ask, explore, challenge, and then respectfully assert if you agree or disagree. If your idea is rejected, be more persuasive, not bitter.
* **Welcoming to new members.** New members bring new perspectives. Some may raise questions that have been addressed before. Kindly point them to existing discussions. Everyone is new to every project once.
* **Be kind to beginners.** Beginners use open source projects to get experience. They might not be talented coders yet, and projects should not accept poor quality code. But we were all beginners once, and we need to engage kindly.
* **Consider your impact on others.** Your work will be used by others, and you depend on the work of others. We expect community members to be considerate and establish a balance their self-interest with communal interest.
* **Consider your impact on others.** Your work will be used by others, and you depend on the work of others. We expect community members to be considerate and establish a balance between their self-interest and communal interest.
* **Use words carefully.** We may not understand intent when you say something ironic. Poe’s Law suggests that without an emoticon people will misinterpret sarcasm. We ask community members to communicate plainly.
* **Leave with class.** When you wish to resign from participating in this project for any reason, you are free to fork the code and create a competitive project. Open Source explicitly allows this. Your exit should not be dramatic or bitter.

Expand All @@ -34,7 +34,7 @@ Participants remain in good standing when they do not engage in misconduct or ha
* **Don't disrupt.** Sustained disruptions in a discussion.
* **Let us help.** Refusal to assist the Response Team to resolve an issue in the community.

We do not list all forms of harassment, nor imply some forms of harassment are not worthy of action. Any participant who *feels* harassed or *observes* harassment, should report the incident. Victim of harassment should not address grievances in the public forum, as this often intensifies the problem. Report it, and let us address it off-line.
We do not list all forms of harassment, nor imply some forms of harassment are not worthy of action. Any participant who *feels* harassed or *observes* harassment, should report the incident. Victims of harassment should not address grievances in the public forum, as this often intensifies the problem. Report it, and let us address it off-line.

### Reporting Issues
If you experience or witness misconduct, or have any other concerns about the conduct of members of this project, please report it by contacting our Response Team at opensource-conduct@verizonmedia.com who will handle your report with discretion. Your report should include:
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -135,7 +135,7 @@ The documentation lives on our website at [arkime.com/api](https://arkime.com/ap

### Code of Conduct

We encourage inclusive and professional interactions on our project. We welcome everyone to open an issue, improve the documentation, report bug or submit a pull request. By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). If you feel there is a conduct issue related to this project, please raise it per the Code of Conduct process and we will address it.
We encourage inclusive and professional interactions on our project. We welcome everyone to open an issue, improve the documentation, report a bug or submit a pull request. By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). If you feel there is a conduct issue related to this project, please raise it per the Code of Conduct process and we will address it.

---

Expand Down
4 changes: 2 additions & 2 deletions capture/DESIGN.md
Expand Up @@ -4,7 +4,7 @@ Capture is a multithreaded glib2 application

In general capture tries to not use locks for anything but queues when communicating between threads.
When possible we use read only complex data structures shared across threads.
When those data structures need to be updated we create a new one and replace the old one, which is schedule to be freed at a later time (moloch_free_later) so any curernt readers don't crash.
When those data structures need to be updated we create a new one and replace the old one, which is scheduled to be freed at a later time (moloch_free_later) so any current readers don't crash.

## capture
The main thread, all http requests are on the main thread.
Expand Down Expand Up @@ -36,7 +36,7 @@ A single thread that is responsible for writing out to disk the completed pcap b

# Parsers vs Plugins

In reality there isn't much difference between parsers and plugins, other then when they are loaded and when they are initialized.
In reality there isn't much difference between parsers and plugins, other than when they are loaded and when they are initialized.

## Parsers
Anything in the parsers directories (parsersDir) are auto loaded and the moloch_parser_init function is called when loaded.
Expand Down
2 changes: 1 addition & 1 deletion viewer/README.md
Expand Up @@ -61,7 +61,7 @@ npm run start:testuser

For this to work, your `tests/config.test.ini` must be valid.

These first command adds an "admin" user. The second command starts the node server and bundles all Vue app files into `viewer/vueapp/dist`.
The first command adds an "admin" user. The second command starts the node server and bundles all Vue app files into `viewer/vueapp/dist`.

Webpack watches for changes to relevant Vue files, and re-bundles the Vue app after each save.

Expand Down
2 changes: 1 addition & 1 deletion wiseService/README.md
Expand Up @@ -56,7 +56,7 @@ To start the app for development and testing:
* Move to the top level Arkime directory
* run `npm run wise:dev`

This command starts the app with the necessary config options set (`-c ../tests/config.test.ini`) and bundles the unminified application files into into the `wiseService/vueapp/dist` folder.
This command starts the app with the necessary config options set (`-c ../tests/config.test.ini`) and bundles the unminified application files into the `wiseService/vueapp/dist` folder.

`npm run wise:dev` uses webpack to package the files then watches for changes to relevant files, and re-bundles the app after each save.

Expand Down
2 changes: 1 addition & 1 deletion wiseService/molochwise.bro
Expand Up @@ -177,7 +177,7 @@ event file_hash(f: fa_file, kind: string, hash: string)
flush_all();
}

# Make sure nothing is waiting more then 5 seconds
# Make sure nothing is waiting more than 5 seconds
event wisetimer()
{
if (|wise_next_lookups["md5"]| > 0 || |wise_next_lookups["ip"]| > 0) {
Expand Down
2 changes: 1 addition & 1 deletion wiseService/simpleSource.js
Expand Up @@ -31,7 +31,7 @@ const iptrie = require('iptrie');
* Sources need to
* * implement WISESource#initSource
* * implement SimpleSource#simpleSourceLoad
* * they can optionaly call this.load() if they want to force a reload of data
* * they can optionally call this.load() if they want to force a reload of data
* @extends WISESource
*/
class SimpleSource extends WISESource {
Expand Down
2 changes: 1 addition & 1 deletion wiseService/wiseService.ini.sample
@@ -1,5 +1,5 @@
# Configuration for WISE and the data sources are contained in this file.
# See https://molo.ch/wise
# See https://arkime.com/wise


# Configuration for the wiseService itself.
Expand Down
2 changes: 1 addition & 1 deletion wiseService/wiseService.js
@@ -1,5 +1,5 @@
/******************************************************************************/
/* wiseService.js -- Server requests between moloch and various intel services
/* wiseService.js -- Server requests between Arkime and various intel services
* and files
*
* Copyright 2012-2016 AOL Inc. All rights reserved.
Expand Down