Use links when referencing other files in the repo

This commit is contained in:
Łukasz Mierzwa
2017-03-27 22:30:37 -07:00
parent 1af3d08870
commit 317936d107
3 changed files with 13 additions and 17 deletions
+3 -2
View File
@@ -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,
-13
View File
@@ -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.
+10 -2
View File
@@ -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).