From 666ce2048d99be416215abbc7b25c04ef5ecacc4 Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Tue, 25 Sep 2018 17:05:16 -0700 Subject: [PATCH] Add documentation for GitHub return functionality --- _site/content/modules/github.md | 3 + docs/index.json | 4 +- docs/modules/gerrit/index.html | 21 -- docs/modules/github/index.html | 3 + docs/modules/hackernews/index.html | 173 ++++++++++- docs/modules/ipaddress/ipinfo/index.html | 271 ------------------ .../weather_services/prettyweather/index.html | 96 ------- 7 files changed, 175 insertions(+), 396 deletions(-) diff --git a/_site/content/modules/github.md b/_site/content/modules/github.md index 449ebab8..c02bcc66 100644 --- a/_site/content/modules/github.md +++ b/_site/content/modules/github.md @@ -40,6 +40,9 @@ wtf/github/ Key: `→`
Action: Show the next git repository. +Key: `Return`
+Action: Open the selected repository in a browser. + ## Configuration ```yaml diff --git a/docs/index.json b/docs/index.json index 573e028d..e106805b 100644 --- a/docs/index.json +++ b/docs/index.json @@ -158,7 +158,7 @@ "title": "GitHub", "tags": [], "description": "", - "content": " Displays information about your git repositories hosted on GitHub:\nOpen Review Requests All open code review requests assigned to you.\nOpen Pull Requests All open pull requests created by you.\nSource Code wtf/github/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: h Action: Show the previous git repository.\nKey: l Action: Show the next git repository.\nKey: ← Action: Show the previous git repository.\nKey: → Action: Show the next git repository.\nConfiguration github:apiKey:\u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34;baseURL:\u0026#34;\u0026#34;enabled:trueenableStatus:trueposition:top:2left:3height:2width:2refreshInterval:300repositories:wesker-api:\u0026#34;UmbrellaCorp\u0026#34;wtf:\u0026#34;senorprogrammer\u0026#34;uploadURL:\u0026#34;\u0026#34;username:\u0026#34;senorprogrammer\u0026#34; Attributes apiKey Value: Your GitHub API token.\nbaseURL Optional Value: Your GitHub Enterprise API URL.\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nenableStatus Display pull request mergeability status (\u0026lsquo;dirty\u0026rsquo;, \u0026lsquo;clean\u0026rsquo;, \u0026lsquo;unstable\u0026rsquo;, \u0026lsquo;blocked\u0026rsquo;).\nValues: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nrepositories A list of key/value pairs each describing a GitHub repository to fetch data for. Key: The name of the repository. Value: The name of the account or organization that owns the repository.\nuploadURL Optional Value: Your GitHub Enterprise upload URL (often the same as API URL).\nusername Your GitHub username. Used to figure out which review requests you\u0026rsquo;ve been added to.\n" + "content": " Displays information about your git repositories hosted on GitHub:\nOpen Review Requests All open code review requests assigned to you.\nOpen Pull Requests All open pull requests created by you.\nSource Code wtf/github/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: h Action: Show the previous git repository.\nKey: l Action: Show the next git repository.\nKey: ← Action: Show the previous git repository.\nKey: → Action: Show the next git repository.\nKey: Return Action: Open the selected repository in a browser.\nConfiguration github:apiKey:\u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34;baseURL:\u0026#34;\u0026#34;enabled:trueenableStatus:trueposition:top:2left:3height:2width:2refreshInterval:300repositories:wesker-api:\u0026#34;UmbrellaCorp\u0026#34;wtf:\u0026#34;senorprogrammer\u0026#34;uploadURL:\u0026#34;\u0026#34;username:\u0026#34;senorprogrammer\u0026#34; Attributes apiKey Value: Your GitHub API token.\nbaseURL Optional Value: Your GitHub Enterprise API URL.\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nenableStatus Display pull request mergeability status (\u0026lsquo;dirty\u0026rsquo;, \u0026lsquo;clean\u0026rsquo;, \u0026lsquo;unstable\u0026rsquo;, \u0026lsquo;blocked\u0026rsquo;).\nValues: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nrepositories A list of key/value pairs each describing a GitHub repository to fetch data for. Key: The name of the repository. Value: The name of the account or organization that owns the repository.\nuploadURL Optional Value: Your GitHub Enterprise upload URL (often the same as API URL).\nusername Your GitHub username. Used to figure out which review requests you\u0026rsquo;ve been added to.\n" }, { "uri": "https://wtfutil.com/modules/gitlab/", @@ -341,4 +341,4 @@ "tags": [], "description": "", "content": "" -}] +}] \ No newline at end of file diff --git a/docs/modules/gerrit/index.html b/docs/modules/gerrit/index.html index cd1ff3c8..586c804d 100644 --- a/docs/modules/gerrit/index.html +++ b/docs/modules/gerrit/index.html @@ -148,27 +148,6 @@ Crypo Currencies
  • diff --git a/docs/modules/github/index.html b/docs/modules/github/index.html index 67ba7ccf..7cffd48f 100644 --- a/docs/modules/github/index.html +++ b/docs/modules/github/index.html @@ -503,6 +503,9 @@

    Key: →
    Action: Show the next git repository.

    +

    Key: Return
    +Action: Open the selected repository in a browser.

    +

    Configuration

    github:
   apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
diff --git a/docs/modules/hackernews/index.html b/docs/modules/hackernews/index.html
index b63a531a..d0b26ad8 100644
--- a/docs/modules/hackernews/index.html
+++ b/docs/modules/hackernews/index.html
@@ -219,17 +219,178 @@
       Google Apps