From 1af3d0887054198265bd95dc2fd21a593278693a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Mierzwa?= Date: Mon, 27 Mar 2017 22:26:53 -0700 Subject: [PATCH 1/2] Use correct name for the license file Checked with https://help.github.com/articles/adding-a-license-to-a-repository/ and there should be no '.md' extension on this file --- LICENSE | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..e1a4e2dab --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright (c) 2017, CloudFlare. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. From 317936d10785aa604884a7673c95db169d5b532c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Mierzwa?= Date: Mon, 27 Mar 2017 22:27:41 -0700 Subject: [PATCH 2/2] Use links when referencing other files in the repo --- CONTRIBUTING.md | 5 +++-- LICENSE.md | 13 ------------- README.md | 12 ++++++++++-- 3 files changed, 13 insertions(+), 17 deletions(-) delete mode 100644 LICENSE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fad14291..d318b128d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,8 @@ ## Getting Started -To get started follow `Building from source` section of the `README.md` file. +To get started follow `Building from source` section of the [README](README.md) +file. ## Testing changes @@ -31,7 +32,7 @@ To update specific vendor package run manul manually: ## Running To build and start `unsee` from local branch see `Running` section of the -`README.md` file. +[README](README.md) file. When working with assets (templates, stylesheets and javascript files) `DEBUG` flag for make can be set, which will recompile binary assets in debug mode, diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index e1a4e2dab..000000000 --- a/LICENSE.md +++ /dev/null @@ -1,13 +0,0 @@ -Copyright (c) 2017, CloudFlare. All rights reserved. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/README.md b/README.md index 5a3b19883..938952831 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,8 @@ To clone git repo and build the binary yourself run: `unsee` is configured via environment variables or command line flags. Environment variable `ALERTMANAGER_URI` or cli flag `-alertmanager.uri` is the -only option required to run. See `Environment variables` section below for the -full list of supported environment variables. Examples: +only option required to run. See [Environment variables](#environment-variables) +section below for the full list of supported environment variables. Examples: ALERTMANAGER_URI=https://alertmanager.example.com unsee unsee -alertmanager.uri https://alertmanager.example.com @@ -255,3 +255,11 @@ This option can also be set using `-strip.labels` flag. Example: $ unsee -strip.labels "prometheus_instance alert_type" This variable is optional and default is not set (all labels will be shown). + +## Contributing + +Please see [CONTRIBUTING](/CONTRIBUTING.md) for details. + +## License + +Apache License 2.0, please see [LICENSE](/LICENSE).