Skip to content

Commit 5057257

Browse files
authored
Added README from patcon/go.talent.c4nada.ca .
1 parent 580747a commit 5057257

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

README.md

+43-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,43 @@
1-
# link.g0v.network
1+
# Shortlinks: `link.g0v.network`
2+
3+
This code repository contains a list of helpful shortlinks for finding public resources.
4+
5+
The shortlinks are automatically updated on each change to this repository
6+
7+
[![screencast of shortlinks in action](http://g.recordit.co/tcG9ky2XQz.gif)](https://recordit.co/tcG9ky2XQz)
8+
9+
## Why?
10+
11+
Maintaining a shortlink service with other people allows:
12+
1. Building a common language of keywords, helpful for voice communication and finding the digital resources themselves,
13+
2. Updating shortlink keywords allows resources to be migrated without requiring everyone to be notified.
14+
15+
| Workflow | Status |
16+
|----------|--------|
17+
| :gear: [`update-shortlinks`][] | :scroll: [![Shortlink Badge][shortlink-badge]][shortlink-logs]
18+
19+
[`update-shortlinks`]: /.github/workflows/update-shortlinks.yml
20+
[shortlink-badge]: https://github.com/g0v-network/link.g0v.network/actions/workflows/update-shortlinks.yml/badge.svg
21+
[shortlink-logs]: https://github.com/g0v-network/link.g0v.networ/actions/workflows/update-shortlinks.yml
22+
23+
DNS records for this shortlink service are managed in a collectively-run code repository, [`link.g0v.network/domains`][g0v-domains]. You can view the specific config file for this subdomain at: [`link.g0v.network/dns`][dns]
24+
25+
[dns]: https://link.g0v.network/dns
26+
[g0v-domains]: https://link.g0v.network/domains/
27+
28+
## Technologies Used
29+
30+
- **Python.** A programming langauge common in scripting.
31+
- [**`spreadsheet2shortlinks`**][spreadsheet2shortlinks]. Command-line tool for updating Rebrandly shortlinks from a spreadsheet.
32+
- [**GitHub Actions.**][github-actions] A script-running service that runs scheduled tasks for us in the cloud. (Incoming)
33+
- [**Rebrandly.**][rebrandly] Hosted service for managing short, descriptive links with a custom domain. (free tier: 200 links)
34+
35+
[spreadsheet2shortlinks]: https://github.com/hyphacoop/spreadsheet2shortlinks
36+
[github-actions]: https://github.com/features/actions
37+
[rebrandly]: https://support.rebrandly.com/hc/en-us/articles/223459547-What-is-Rebrandly-
38+
39+
## Prior Art
40+
41+
- [`hyphacoop/worker-coop-scripts`](https://github.com/hyphacoop/worker-coop-scripts)
42+
- [`CivicTechTO/civictechto-scripts`](https://github.com/CivicTechTO/civictechto-scripts)
43+
- [`patcon/go.talent.c4nada.ca`](https://github.com/patcon/go.talent.c4nada.ca)

0 commit comments

Comments
 (0)