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