Merge pull request #845 from mDuo13/getinfoscript

Diagnosing: getRippledInfo script

content/tutorials/manage-the-rippled-server/troubleshooting/diagnosing-problems.md

@@ -2,7 +2,10 @@
 
 If you are having problems with `rippled`, the first step is to collect more information to accurately characterize the problem. From there, it can be easier to figure out a root cause and a fix.
 
-If your server does not start (such as crashing or otherwise shutting down automatically), see [rippled Server Won't Start](server-wont-start.html) for a list of some possible causes and fixes.
+See the following pages for some common categories of problems, their causes, and fixes:
+
+- If your server does not start (such as crashing or otherwise shutting down automatically), see **[rippled Server Won't Start](server-wont-start.html)**.
+- If your server starts, but does not reliably sync or remain synced to the XRP Ledger network, see **[rippled Server Doesn't Sync](server-doesnt-sync.html)**.
 
 The remainder of this document suggests steps for diagnosing problems that happen while your server is up and running (including if the process is active but unable to sync with the network).
 
@@ -112,6 +115,43 @@ It is normal for a `rippled` the server to print many warning-level (`WRN`) mess
 For a more thorough explanation of various types of log messages, see [Understanding Log Messages](understanding-log-messages.html).
 
 
+## Info Collection Script
+
+If you have problems diagnosing the problem, or you are unable to resolve the problem with any of the common fixes, you may want to ask for help in a support forum or the [GitHub issues](https://github.com/ripple/rippled/issues). When asking for help, you can use an info collection script to gather information about your system to help others diagnose the issue.
+
+The official package installation (for [Ubuntu/Debian](install-rippled-on-ubuntu.html) or [CentOS/RedHat](install-rippled-on-centos-rhel-with-yum.html)) installs such a script by default, to `/opt/ripple/bin/getRippledInfo`. [New in: rippled 1.5.0][] If you compiled `rippled` yourself, you can find the same script [in the `rippled` source code repository](https://github.com/ripple/rippled/blob/develop/bin/getRippledInfo).
+
+To use the script:
+
+1. Run the script while `rippled` is running.
+
+        $ /opt/ripple/bin/getRippledInfo
+
+        ####################################################
+          rippled info has been gathered. Please copy the
+          contents of /tmp/ripple_info.Xo8Xr/rippled_info.md
+          to a github gist at https://gist.github.com/
+
+          PLEASE REVIEW THIS FILE FOR ANY SENSITIVE DATA
+          BEFORE POSTING! We have tried our best to omit
+          any sensitive information from this file, but you
+          should verify before posting.
+        ####################################################
+
+    The script collects the output of numerous commands and writes them to a temporary file. The filename is randomized with a string of letters and numbers (case-sensitive), for example: `/tmp/ripple_info.Xo8Xr/rippled_info.md`
+
+
+2. Look over the output file for sensitive information.
+
+    The script attempts to scrub sensitive information from the output, such as validator keys or tokens. However, you should still check the output before posting publicly, as a precaution. For example, the script outputs detailed information about your server hardware, and you may want to remove some sections for privacy reasons. Use a text editor to read the output file and to remove anything you don't want to post.
+
+        nano /tmp/ripple_info.Xo8Xr/rippled_info.md
+
+3. Upload the output file where others can see it.
+
+    You can upload the file directly to [GitHub Gist](https://gist.github.com/), [Pastebin](https://pastebin.com/), or a similar service. If you are running `rippled` on a remote server, you may find it easier to first transfer the file to a machine with a web browser, using `scp` or a similar tool.
+
+
 ## See Also
 
 - **Concepts:**

dactyl-config.yml

@@ -69,6 +69,8 @@ targets:
         github_forkurl: https://github.com/ripple/xrpl-dev-portal
         github_branch: master
         locale_file: locale/en/LC_MESSAGES/messages.mo
+        link_subs:
+            "./src/api-v3/paths/preparations/payments.ts": "https://github.com/xpring-eng/xrp-api/blob/master/src/api-v3/paths/preparations/payments.ts"
 
     -   name: ja
         lang: ja
@@ -77,6 +79,8 @@ targets:
         github_branch: master
         locale_file: locale/ja/LC_MESSAGES/messages.mo
         link_subs:
+            # Adjust XRP-API readme link to point to the right place in the repo
+            "./src/api-v3/paths/preparations/payments.ts": "https://github.com/xpring-eng/xrp-api/blob/master/src/api-v3/paths/preparations/payments.ts"
             # Fix 2 links from untranslated send-xrp.html:
             "accounts.html#creating-accounts": "accounts.html#アカウントの作成"
             "rippled-server-modes.html#reasons-to-run-a-stock-server": "rippled-server-modes.html#ストックサーバーを運用する理由"
@@ -161,6 +165,8 @@ targets:
             # Fix links from untranslated validator-list.html
             "run-rippled-as-a-validator.html#3-enable-validation-on-your-rippled-server": "run-rippled-as-a-validator.html#3-rippledサーバーで検証を有効化"
             "basic-data-types.html#specifying-time": "basic-data-types.html#時間の指定"
+            # Fix link from untranslated run-rippled-as-a-wallet-server.html
+            "run-rippled-as-a-validator.html#6-provide-domain-verification": "run-rippled-as-a-validator.html#6-ドメイン検証の提供"
 
 
     -   name: xrp-api-only
@@ -169,6 +175,8 @@ targets:
         github_forkurl: https://github.com/ripple/xrpl-dev-portal
         github_branch: master
         no_cover: true
+        link_subs:
+            "./src/api-v3/paths/preparations/payments.ts": "https://github.com/xpring-eng/xrp-api/blob/master/src/api-v3/paths/preparations/payments.ts"
 
     # Data API target for porting changes to the README in the upstream repo
     # Intended for use in markdown (--md) mode.
@@ -2223,6 +2231,7 @@ pages:
         blurb: A multipurpose configuration for anyone integrating XRP. #TODO:translate
         targets:
             - en
+            - ja
 
     -   md: tutorials/manage-the-rippled-server/configuration/configure-statsd.md
         html: configure-statsd.html
@@ -5555,6 +5564,8 @@ pages:
         funnel: Docs
         doc_type: References
         supercategory: XRP-API
+        filters:
+            - xrpapi_readme
         targets:
             - en
             - ja
@@ -5919,6 +5930,9 @@ known_broken_links:
     - http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2006:345:0001:0009:EN:PDF
     # Dev blog link assumes relationship with xrpl.org
     - /blog/
+    - /blog/label/rippled-release-notes.html
+    - /blog/label/amendments.html
+    - /blog/label/features.html
     # For some reason the Web Archive links are breaking in the link checker
     #  even though they still work in browser:
     - https://web.archive.org/web/20161007113240/https://wiki.ripple.com/Ripple.txt

tool/filter_xrpapi_readme.py

@@ -0,0 +1,13 @@
+def filter_markdown(md, **kwargs):
+    """
+    Remove the link to the dev portal from the readme and replace it with
+    a link to the repo (since we're in the dev portal already).
+    """
+
+    REMOVE = """## [➡️ XRP API Reference Documentation](https://xrpl.org/xrp-api.html)
+
+See the full reference documentation on the XRP Ledger Dev Portal."""
+
+    REPLACEMENT = """[[Source]](https://github.com/xpring-eng/xrp-api "Source")"""
+
+    return md.replace(REMOVE, REPLACEMENT)