refactor(web/atward): translate index page to markdown
Change-Id: I03ccbec1dd8ba58d80bd97eb40148dd395e500b2 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3115 Tested-by: BuildkiteCI Reviewed-by: tazjin <mail@tazj.in>
This commit is contained in:
sterni
parent
25ff41452b
commit
c92f4ceacc
1 changed files with 45 additions and 53 deletions
|
|
@ -4,56 +4,49 @@ depot.web.tvl.template {
|
||||||
useUrls = true;
|
useUrls = true;
|
||||||
title = "atward";
|
title = "atward";
|
||||||
content = ''
|
content = ''
|
||||||
<p>
|
**atward** is [TVL's](https://tvl.fyi/) search
|
||||||
<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
|
||||||
service. It can be configured as a browser search engine for easy
|
access to TVL bugs, code reviews, code paths and more.
|
||||||
access to TVL bugs, code reviews, code paths and more.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h3>Setting up atward</h3>
|
### Setting up atward
|
||||||
<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>
|
To configure atward, add a search engine to your browser with the
|
||||||
<p>
|
following search string: `https://at.tvl.fyi/?q=%s`
|
||||||
The following query types are supported in atward:
|
Consider setting a shortcut, for example **t** or **tvl**.
|
||||||
<ul>
|
You can now quickly access TVL resources by typing something
|
||||||
<li><kbd>b/42</kbd> - access bugs with ID 42</li>
|
like <kbd>t b/42</kbd> in your URL bar to get to the bug with ID
|
||||||
<li><kbd>cl/3087</kbd> - access changelist with ID 3087</li>
|
42.
|
||||||
<li><kbd>//web/atward</kbd> - open the <b>//web/atward</b> path in TVLs monorepo</li>
|
|
||||||
</ul>
|
|
||||||
</p>
|
### Supported queries
|
||||||
|
|
||||||
|
The following query types are supported in atward:
|
||||||
|
|
||||||
|
* <kbd>b/42</kbd> - access bugs with ID 42
|
||||||
|
* <kbd>cl/3087</kbd> - access changelist with ID 3087
|
||||||
|
* <kbd>//web/atward</kbd> - open the **//web/atward** path in TVLs monorepo
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
Some behaviour of atward can be configured by adding query
|
||||||
|
parameters to the search string:
|
||||||
|
|
||||||
|
* <kbd>cs=true</kbd> - use Sourcegraph instead of cgit to view code
|
||||||
|
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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>
|
||||||
|
|
||||||
<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>
|
<noscript>
|
||||||
<p class="cheddar-callout cheddar-warning">
|
<p class="cheddar-callout cheddar-warning">
|
||||||
The form above only works with Javascript enabled. Only a few
|
The form above only works with Javascript enabled. Only a few
|
||||||
|
|
@ -62,12 +55,11 @@ depot.web.tvl.template {
|
||||||
</p>
|
</p>
|
||||||
</noscript>
|
</noscript>
|
||||||
|
|
||||||
<h3>Source code</h3>
|
### Source code
|
||||||
<p>
|
|
||||||
atward's source code lives
|
atward's source code lives at
|
||||||
at <a href="https://atward.tvl.fyi/?q=%2F%2Fweb%2Fatward">//web/atward</a>.
|
[//web/atward](https://atward.tvl.fyi/?q=%2F%2Fweb%2Fatward).
|
||||||
</p>
|
'';
|
||||||
'';
|
|
||||||
extraHead = ''
|
extraHead = ''
|
||||||
<script>
|
<script>
|
||||||
/* Initialise the state of all settings. */
|
/* Initialise the state of all settings. */
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue