From 375482c16db62af600f4225eb89a55559df73733 Mon Sep 17 00:00:00 2001 From: afeiszli Date: Wed, 14 Apr 2021 13:16:56 -0400 Subject: [PATCH] updating docs --- licensing/LICENSE.txt => LICENSE.txt | 0 README.md | 4 ++-- docs/API.md | 2 +- docs/CONTRIBUTING.md | 2 +- docs/TROUBLESHOOTING.md | 19 +++++++++++++++++++ docs/{GETTING_STARTED.md => USAGE.md} | 0 6 files changed, 23 insertions(+), 4 deletions(-) rename licensing/LICENSE.txt => LICENSE.txt (100%) rename docs/{GETTING_STARTED.md => USAGE.md} (100%) diff --git a/licensing/LICENSE.txt b/LICENSE.txt similarity index 100% rename from licensing/LICENSE.txt rename to LICENSE.txt diff --git a/README.md b/README.md index a70744ff..6a2e7b60 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ In future releases, we have plans to support other platforms such as Windows and ## Docs **For more information, please read the docs, or check out the Quick Start below:** - - [Getting Started](docs/GETTING_STARTED.md) + - [General Usage](docs/USAGE.md) - [Troubleshooting](docs/TROUBLESHOOTING.md) - [API Documentation](docs/API.md) - [Product Roadmap](docs/ROADMAP.md) @@ -70,7 +70,7 @@ Run the following: `curl -sfL https://raw.githubusercontent.com/gravitl/netmaker #### LICENSE -Netmaker's source code and all artifacts in this repository are freely available. All versions are published under the Server Side Public License (SSPL), version 1, which can be found under the "licensing" directory: [LICENSE.txt](licensing/LICENSE.txt). +Netmaker's source code and all artifacts in this repository are freely available. All versions are published under the Server Side Public License (SSPL), version 1, which can be found here: [LICENSE.txt](./LICENSE.txt). #### CONTACT diff --git a/docs/API.md b/docs/API.md index 98d64374..03d88d24 100644 --- a/docs/API.md +++ b/docs/API.md @@ -6,7 +6,7 @@ Most actions that can be performed via API can be performed via UI. We recommend #### Authentication In general, API calls must be authenticated via a header of the format `-H "Authorization: Bearer "` There are two methods of obtaining YOUR_SECRET_KEY: -1. Using the masterkey. By default, this value is "secret key," but you should change this on your instance and keep it secure. This value can be set via env var at startup or in a config file (config/environments/< env >.yaml). See the [getting started](./GETTING_STARTED.md) documentation for more details. +1. Using the masterkey. By default, this value is "secret key," but you should change this on your instance and keep it secure. This value can be set via env var at startup or in a config file (config/environments/< env >.yaml). See the [general usage](./USAGE.md) documentation for more details. 2. Using a JWT recieved for a node. This can be retrieved by calling the `/api/nodes//authenticate` endpoint, as documented below. #### Format diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index db6f8815..35adf29a 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -25,4 +25,4 @@ When submitting a PR, you will be asked to sign a CLA, defined [here](https://gi This project is evolving quickly and we may want to move to an MIT or GPL license at some point in the near future, which would be difficult without a CLA. ## Licensing -Any contributions you make will be under the SSPL Software License. When you submit code changes, you understand that they will be under the same license that covers this project, defined [here](../licensing/LICENSE.txt). If you have any concerns around this, feel free to contact the maintainers. +Any contributions you make will be under the SSPL Software License. When you submit code changes, you understand that they will be under the same license that covers this project, defined [here](../LICENSE.txt). If you have any concerns around this, feel free to contact the maintainers. diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index 299d2ccd..110758b2 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -1,2 +1,21 @@ +# Netmaker Troubleshooting Help + +## Client (netclient) + +### Client fails to install + +### Cannot run install script + +### Issue with accesstoken created by UI + + +## Server + +## UI + +## MongoDB + + + ## Incorrect backend detected. Please specify correct URL and refresh. Given: http://localhost:8081 Solution: Front end expects a reachable address for the backend. Localhost is default. Check if server is up. If server is up, make sure you've got the right endpoint (endpoint of server. Will not be 'localhost' unless doing local testing). If server is up and endpoint is correct, check for port blockings. diff --git a/docs/GETTING_STARTED.md b/docs/USAGE.md similarity index 100% rename from docs/GETTING_STARTED.md rename to docs/USAGE.md