mirror of
https://github.com/openziti/zrok.git
synced 2024-11-07 08:44:14 +01:00
add standard markdowns, start to fill them out
This commit is contained in:
parent
b1dcbb1499
commit
aec01ad1f3
8
BUILD.md
Normal file
8
BUILD.md
Normal file
@ -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`
|
17
CODE_OF_CONDUCT.md
Normal file
17
CODE_OF_CONDUCT.md
Normal file
@ -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.
|
6
CONTRIBUTING.md
Normal file
6
CONTRIBUTING.md
Normal file
@ -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.
|
@ -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).
|
11
SECURITY.md
Normal file
11
SECURITY.md
Normal file
@ -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
|
@ -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",
|
||||
|
Loading…
Reference in New Issue
Block a user