about summary refs log tree commit diff
path: root/web/atward/src/index.html
blob: a62d168bda0e8def70849ed65b433617beab66ef (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<!DOCTYPE html>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="The Virus Lounge">
<link rel="stylesheet" type="text/css" href="https://tvl.fyi/static/tazjin.css" media="all">
<link rel="icon" type="image/webp" href="https://tvl.fyi/static/favicon.webp">
<link rel="search" type="application/opensearchdescription+xml" title="TVL Search" href="https://at.tvl.fyi/opensearch.xml">
<title>TVL Search</title>
<script>
  /* Initialise the state of all settings. */
  function loadSettings() {
      loadSetting(document.getElementById('cs-setting'), 'cs');
  }

  /* Initialise the state of a setting from a cookie. */
  function loadSetting(checkbox, name) {
      if (document.cookie.split(';').some(function(cookie) {
          return cookie.indexOf(`${name}=true`) >= 0;
      })) {
          checkbox.checked = true;
      }
  }

  /* Persist the state of a checkbox in a cookie */
  function saveSetting(checkbox, name) {
      console.log(`setting atward parameter '${name}' to ${checkbox.checked.toString()}`);
      document.cookie = `${name}=${checkbox.checked.toString()};`;
  }
</script>
<body class="light" onload="loadSettings();">
  <header>
    <h1><a class="blog-title" href="/">atward</a></h1>
    <hr/>
  </header>

  <p>
    <b>atward</b> is <a href="https://tvl.fyi/">TVL's</a> search
    service. It can be configured as a browser search engine for easy
    access to TVL bugs, code reviews, code paths and more.
  </p>

  <h3>Setting up atward</h3>
  <p>
    To configure atward, add a search engine to your browser with the
    following search string:
    <pre>  https://at.tvl.fyi/?q=%s</pre>
    Consider setting a shortcut, for example <b>t</b> or <b>tvl</b>.
    You can now quickly access TVL resources by typing something
    like <kbd>t b/42</kbd> in your URL bar to get to the bug with ID
    42.
  </p>

  <h3>Supported queries</h3>
  <p>
    The following query types are supported in atward:
    <ul>
      <li><kbd>b/42</kbd> - access bugs with ID 42</li>
      <li><kbd>cl/3087</kbd> - access changelist with ID 3087</li>
      <li><kbd>//web/atward</kbd> - open the <b>//web/atward</b> path in TVLs monorepo</li>
    </ul>
  </p>

  <h3>Configuration</h3>
  <p>
    Some behaviour of atward can be configured by adding query
    parameters to the search string:
    <ul>
      <li><kbd>cs=true</kbd> - use Sourcegraph instead of cgit to view code</li>
    </ul>
  </p>
  <p>
    In some browsers (like Firefox) users can not edit query
    parameters for search engines. As an alternative configuration can
    be supplied via cookies with the same names as the configuration
    parameters.
  </p>
  <p>
    The form below can set this configuration:
    <form class="cheddar-callout cheddar-todo">
      <input type="checkbox"
             id="cs-setting"
             onchange="saveSetting(this, 'cs');"
             > Use Sourcegraph instead of cgit</input>
    </form>
  </p>
  <noscript>
    <p class="cheddar-callout cheddar-warning">
      The form above only works with Javascript enabled. Only a few
      lines of Javascript are used, and they are licensed under a
      free-software license (MIT).
    </p>
  </noscript>

  <h3>Source code</h3>
  <p>
    atward's source code lives
    at <a href="https://atward.tvl.fyi/?q=%2F%2Fweb%2Fatward">//web/atward</a>.
  </p>

  <hr/>
  <footer>
    <p class="footer">
      <a class="uncoloured-link" href="https://cs.tvl.fyi/depot/-/blob/README.md">code</a>
      |
      <a class="uncoloured-link" href="https://cl.tvl.fyi/">reviews</a>
      |
      <a class="uncoloured-link" href="https://b.tvl.fyi/">bugs</a>
      |
      <a class="uncoloured-link" href="https://todo.tvl.fyi/">todos</a>
    </p>
    <p class="lod">ಠ_ಠ</p>
  </footer>
</body>