We can't find the internet
Attempting to reconnect
Something went wrong!
Hang in there while we get back on track
pipa / README.md
1
# Pipa
2
3
* [Getting started](https://nossa.ee/~talya/pipa/#getting-started)
4
* [Features](https://nossa.ee/~talya/pipa/#features)
5
* [Legal](https://nossa.ee/~talya/pipa/#legal)
6
* [Contact](https://nossa.ee/~talya/pipa/#contact)
7
8
The Pipa Index.
9
10
A [Greasemonkey script](gm.js) inserts [this little guy](https://www.instagram.com/pipapeep/):
11
12
13
14
... onto pages of your choosing:
15
16
17
18
He will take you to the Pipa Index for that page:
19
20
21
22
Page isn't in the Index? The Pipa is angry!
23
24
25
26
Do not be alarmed. He will invite you to create a new entry in the Pipa Index:
27
28
29
30
The columns in the Index are defined by you.
31
32
33
34
All changes are saved in an event log.
35
36
37
38
39
## <a id="getting-started"></a>Getting started
40
41
This section is TODO, but I'm including it now to record things that will be
42
useful for it.
43
44
Serving suggestion for "User matches":
45
46
```
47
https://gitlab.com/*
48
https://dev.gitlab.org/*
49
https://github.com/*
50
```
51
52
Serving suggestion for "User excludes" (so you don't get Pipa appearing in
53
iframes):
54
55
```
56
https://gitlab.com/-/sandbox/mermaid*
57
```
58
59
Serving suggestion for "User domain whitelist" (to be used with a `pipa.index`
60
entry in `/etc/hosts`):
61
62
```
63
pipa.index
64
```
65
66
67
## <a id="features"></a>Features
68
69
* Greasemonkey script to insert the Pipa on target pages.
70
* Light/dark mode.
71
* Link multiple URLs to a single entry to tie them together.
72
* Reorder URLs to keep what's most relevant at top.
73
* Define columns for each entry; can also be used to sort. Default sort is saved.
74
* Add comments to entries; supports image attachments.
75
* All changes recorded in a per-entry event log.
76
* Supports gitlab.com and github.com for most activities:
77
* Friendly display of URLs.
78
* Fetch MR/issue status via API, displayed next to MR/issue title reference wherever it appears.
79
* Fetch MR/issue labels via API, displayed under URL in sidebar.
80
* Fetch MR mergeability via API, displayed under URL in sidebar.
81
* All fetched data is cached, and refreshed in the background on access when stale.
82
* Closed or merged issues/MRs are considered stale much less frequently than open ones.
83
* Show CI status in columns for easier view.
84
* Columns and comments can refer to other entries, linked issues and MRs with
85
shorthand reference syntax.
86
87
See [TODO](TODO) for what might come next.
88
89
90
## <a id="legal"></a>Legal
91
92
[Pipa](https://www.instagram.com/pipapeep/) is art by
93
[Rigatoni Garrido](https://www.rigatonigarrido.com/)! You can
94
[buy Pipa merchandise](https://pipapeep.shop/)! This use of the Pipa is
95
totally unauthorised! I will most likely have to change
96
[the included artwork](priv/static/images/pipa.png) if anyone ever notices this!
97
98
99
## <a id="contact"></a>Contact
100
101
@kivikakk on Slack if you're tanuki, otherwise <ashe@kivikakk.ee>.
102
