Skip to content

Commit 54b7f18

Browse files
authored
Obsidian support, improved blip text view (#14)
Adds a part in the readme on how to use Obsidian to edit the blip texts. Also updates the blip text view to make it possible to close without zooming out when there is a lot of text - previously the close button was outside the screen.
1 parent aed7f95 commit 54b7f18

File tree

5 files changed

+75
-11
lines changed

5 files changed

+75
-11
lines changed

.gitignore

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Manually added section
2+
.obsidian/
3+
14
# Created by https://www.toptal.com/developers/gitignore/api/macos,windows,linux,node,visualstudiocode
25
# Edit at https://www.toptal.com/developers/gitignore?templates=macos,windows,linux,node,visualstudiocode
36

@@ -100,7 +103,7 @@ web_modules/
100103
# TypeScript cache
101104
*.tsbuildinfo
102105

103-
# Optional npm cache directory
106+
# Optional npm cache
104107
.npm
105108

106109
# Optional eslint cache
@@ -237,4 +240,4 @@ $RECYCLE.BIN/
237240
# Windows shortcuts
238241
*.lnk
239242

240-
# End of https://www.toptal.com/developers/gitignore/api/macos,windows,linux,node,visualstudiocode
243+
# End of https://www.toptal.com/developers/gitignore/api/macos,windows,linux,node,visualstudiocode

Readme.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,48 @@ And start the development server with
2020
cd capra-fagradar
2121
pnpm dev
2222
```
23+
24+
## Updating contents
25+
26+
Content is found in two folders;
27+
28+
- `src/technical-radar`
29+
- `src/tech-leader-radar`
30+
31+
The files themselves are .mdx files, using .yaml frontmatter for configuration.
32+
These are the config values:
33+
34+
- `id`: unused
35+
- `name`: what it says on the tin
36+
- `depth`: 1-4. See `src/om-fagradar.mdx` for info on the depth levels
37+
- `qudrant`: which named quadrant to put this item in. Quadrant names are set in `index.tsx` for both radars (`const quadrants = [...]`)
38+
39+
Editing can be done in two ways:
40+
41+
1. Using an IDE
42+
1. Using [Obsidian](https://obsidian.md/)
43+
44+
If you have not heard of Obsidian before, you can read about them [here](https://obsidian.md/about)
45+
46+
### How to actually update the contents
47+
48+
#### With an IDE
49+
50+
Requirements: IDE installed, git configured
51+
52+
1. Clone the repo
53+
2. Open it with your IDE
54+
3. Do the changes in the most likely very mediocre markdown editor
55+
4. Commit using your preferred git tool
56+
57+
#### With Obsidian
58+
59+
Requirements: Obsidian installed, git configured
60+
61+
1. Clone the repo
62+
2. Open `src/` as a vault in Obsidian
63+
3. Do the changes with a kick-ass editor
64+
4. Commit using your preferred git tool
65+
66+
To be able to edit the .mdx files you need to install the Obsidian community plugin "mdx as md".
67+
Obsidian also has a very popular Git plugin, if you don't want to do git on the outside.

capra-fagradar/src/radar/index.tsx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,11 @@ const BlipInfo: React.FC<BlipInfoProps> = ({ blip }) => {
399399
{blip.is_new && <Label>new</Label>}
400400
</div>
401401
<div>{blip.element}</div>
402-
<button type="button" onClick={() => selectBlip(undefined)}>
402+
<button
403+
type="button"
404+
className={styles.closeButton}
405+
onClick={() => selectBlip(undefined)}
406+
>
403407
Close
404408
</button>
405409
</RightAnchoredShelf>

capra-fagradar/src/radar/radar.module.css

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,36 @@
11
.rightAnchoredShelf {
22
position: fixed;
33
width: 25vw;
4+
min-width: 320px;
5+
max-width: 50ch;
46
top: 10rem;
7+
bottom: 2rem;
58
right: 0;
69
background: white;
710
border: 0.2rem solid #121c31;
811
border-right: 0;
912
padding: 2rem;
1013
border-radius: 1rem 0 0 1rem;
1114
z-index: 100;
15+
overflow-y: auto;
1216
p {
1317
max-width: 50ch;
1418
}
1519
}
1620

21+
.closeButton {
22+
position: sticky;
23+
bottom: 0;
24+
left: 0;
25+
background: #121c31;
26+
color: white;
27+
border: 0;
28+
padding: 1rem 2rem;
29+
border-radius: 0.5rem;
30+
cursor: pointer;
31+
margin-top: 2rem;
32+
}
33+
1734
.quadrants {
1835
width: 100%;
1936
display: grid;

capra-fagradar/src/tech-leader-radar/Teknologi/event-storming.mdx

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,11 @@ quadrant: Teknologi
66
is_new: true
77
---
88
## Hva er det?
9-
Event Storming er en workshop-basert metode for å raskt finne ut hva som skjer i et domene ved at alle
10-
deltagere kort beskriver hendelser i form av klistrelapper plassert på en tidslinje. Vanlig scenario er
11-
at programvareutviklere og domeneeksperter sammen enes om hva som skjer og hvordan en skal bygge systemet
12-
for å understøtte dette. Grovt sett finnes det tre varianter: én som fokuserer på hendelser og beskriver
13-
helheten, én som beskriver prosessen med aktører, data, kommandoer, systemer og resulterende hendelser,
14-
og én som også inneholder programvarekomponenter som aggregater og forretningsregler.
9+
Event Storming er en workshop-basert metode for å raskt finne ut hva som skjer i et domene ved at alle deltagere kort beskriver hendelser i form av klistrelapper plassert på en tidslinje. Vanlig scenario er at programvareutviklere og domeneeksperter sammen enes om hva som skjer og hvordan en skal bygge systemet
10+
for å understøtte dette. Grovt sett finnes det tre varianter: én som fokuserer på hendelser og beskriver helheten, én som beskriver prosessen med aktører, data, kommandoer, systemer og resulterende hendelser, og én som også inneholder programvarekomponenter som aggregater og forretningsregler.
1511

1612
## Hvorfor er det viktig for oss?
17-
Event Storming er en effektiv og svært enkel teknikk å benytte når en større gruppe mennesker enten skal skape et felles bilde
18-
av et domene og eventuelt designe løsninger kollektivt. Som teknologileder kan vi være gode fasilitatorer da de bør være eksterne.
13+
Event Storming er en effektiv og svært enkel teknikk å benytte når en større gruppe mennesker enten skal skape et felles bilde av et domene og eventuelt designe løsninger kollektivt. Som teknologileder kan vi være gode fasilitatorer da de bør være eksterne.
1914

2015
## Hva gjør vi hvis vi vil bli bedre på dette?
2116
En god starte er boken til oppfinneren Alberto Brandolini, [Introducing EventStorming](https://www.eventstorming.com/book/), samt

0 commit comments

Comments
 (0)