summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMicah Anderson <micah@riseup.net>2013-07-03 11:45:03 -0400
committerMicah Anderson <micah@riseup.net>2013-07-03 16:54:10 -0400
commit76824412771cdeaf4b62fcd711e2f722bd32e08f (patch)
treed48d4c99b437dda52f6665e7b935266c04d15b46 /README.md
parent506c70eb951b7aa18d009fc4fc77ce2f20a6ffe8 (diff)
Copy the current state of the platform documentation into the doc directory.
Originally I thought it would be better to add the leap_doc git repository as a submodule, but I decided against that: . it requires that the user has to start off by initializing submodules, something that the leap_cli does for you . it would result in more up-to-date documentation than was targeted for this release . it would result in an unfortunate directory structure (doc/doc/platform). For these reasons it seemed to me better to put a snapshot of our current platform documentation into the doc directory right before release. This just means a step in our release process of refreshing these docs once we have reviewed them and updated the known-issues for this release. Change-Id: Ib395ea30553772fd195dd50315f026a2576feedd
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.md b/README.md
index 5e9600cd..890008f5 100644
--- a/README.md
+++ b/README.md
@@ -30,14 +30,18 @@ While you can deploy all services on one server, we stronly recommend to use sep
Troubleshooting
===============
-If you have a problem, we are interested in fixing it! The best way for us to solve your problem is if you provide to us the complete log of what you did, and the output that was produced. Please don't cut out what appears to be useless information and only include the error that you received, instead copy and paste the complete log so that we can better determine the overall situation.
+If you have a problem, we are interested in fixing it!
-Visit https://leap.se/en/development for contact possibilities.
+If you have a problem, be sure to have a look at the Known Issues section of the documentation to see if your issue is detailed there.
-Known bugs
-----------
+If not, the best way for us to solve your problem is if you provide to us the complete log of what you did, and the output that was produced. Please don't cut out what appears to be useless information and only include the error that you received, instead copy and paste the complete log so that we can better determine the overall situation. If you can run the same command that produced the error with a raised verbosity level (such as -v2), that provides us with more useful debugging information.
-* Please read the section in the documentation about Known Issues (https://leap.se/docs/known-issues)
+Visit https://leap.se/development for contact possibilities.
+
+Known Issues
+------------
+
+* Please read the section in the documentation about Known Issues (https://leap.se/docs/platform/known-issues)
More Information