From aec01ad1f30df3849072ed700e97465c9ff7e483 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Fri, 27 Jan 2023 08:28:50 -0500 Subject: [PATCH] add standard markdowns, start to fill them out --- BUILD.md | 8 ++++++++ CODE_OF_CONDUCT.md | 17 +++++++++++++++++ CONTRIBUTING.md | 6 ++++++ README.md | 9 +++++++++ SECURITY.md | 11 +++++++++++ package.json | 2 +- 6 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 BUILD.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 00000000..26839631 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,8 @@ +# Build + +At this time, building `zrok` is pretty straight-forward. To build, follow these steps: + +* clone the repository +* change to the existing `build` folder +* run `npm install` +* run `npm run build` \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..9eee7241 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,17 @@ +# Code of Conduct + +All open source projects managed by NetFoundry share a common [code of +conduct](https://netfoundry.github.io/policies/CODE_OF_CONDUCT.html) which all contributors are expected to follow. +Please be sure you read, understand and adhere to the thoughts expressed therein. + +Individuals acting in any way that is considered in violation of the Code of Conduct will receive corrective actions +appropriate for the violation. It is possible to act in ways which technically do not violate the Code of Conduct but +are clearly against the spirit of the project. These situations will also be considered on a case by case basis and if +necessary the Code of Conduct will be revised accordingly and approrpiate notifications will be made to the community +and to the violator. + +## Violations + +Contributors violating the Code of Conduct will receive public notification of the violation. Contined violations or +aggregious violations of the Code of Conduct will result in the contributor being removed from the contributors list as +well as further contributions being declined. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..336dd084 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contributing + +NetFoundry welcomes all and any contributions. All open source projects managed by NetFoundry share a common +[guide for contributions](https://netfoundry.github.io/policies/CONTRIBUTING.html). + +If you are eager to contribute to a NetFoundry-managed open source project please read and act accordingly. diff --git a/README.md b/README.md index 25cce9c9..0c771e4c 100644 --- a/README.md +++ b/README.md @@ -35,3 +35,12 @@ See the [Concepts and Getting Started Guide](docs/v0.3_getting_started/getting_s The single `zrok` binary contains everything you need to operate `zrok` environments and also host your own service instances. Just add a Ziti network and you're up and running. See the [v0.3 Quick Start](docs/v0.3_quickstart.md) for details on getting your own `zrok` service instance running. This builds on top of the [Ziti Quick Start](https://docs.openziti.io/docs/learn/quickstarts/network/) to have you running a `zrok` service instance in minutes. + +## Building + +If you are interested in building `zrok` for yourself instead of using a released package, please rerfer to [BUILD.md](./BUIlD.md) + +## Contributing + +If you'd like to contribute back to `zrok`, that'd be great. Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) page and +abide by the [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md). \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..aa06a21f --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,11 @@ +# Security Policy + +## Supported Versions + +Until v1.0.0 or higher is reached, only the most recent version is supported. After v1.0.0 a new version support statement will be released. + +## Reporting a Vulnerability + +If you have an issue that is not a sensitive security issue, please submit your issue via the GitHub issue tracker on either the main repository. + +If you have a sensitive security issue or are unsure if it is sensitive, please email it to: security@openziti.org diff --git a/package.json b/package.json index 6cf520de..765036e8 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "scripts": { "docusaurus": "docusaurus", "start": "docusaurus start", - "build": "docusaurus build", + "build": "BUILD_PATH='./build/docs docusaurus build", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "clear": "docusaurus clear",