Skip to content

Commit 8213a6b

Browse files
authored
[ENG-276] Move Obsidian publishing script to scripts/ instead of yaml (#180)
* script ready * script clean up * fix readme * update readme * update script * update internal-external versioning * named parameter * small update * update README * other small update * simplify the script * address PR comments
1 parent 530c7a2 commit 8213a6b

29 files changed

Lines changed: 870 additions & 200 deletions

.github/workflows/publish-obsidian.yml

Lines changed: 0 additions & 173 deletions
This file was deleted.

apps/obsidian/README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ For more information about Discourse Graphs, check out our website at [https://d
1313
1. Open Obsidian Settings
1414
2. Go to Community Plugins and disable Restricted Mode
1515
3. Click "Browse" and search for "BRAT"
16-
![BRAT](/apps/obsidian/docs/media/BRAT.png)
16+
![BRAT](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2Faar5LKpLOk.png?alt=media&token=6f51ac48-19d3-4bb5-9a07-7b32cfa6afe6)
1717
4. Install BRAT and enable it
1818

1919
#### Install DataCore via BRAT
2020

2121
1. Open Obsidian Settings
2222
2. Go to "Community Plugins" → "BRAT"
2323
3. Click "Add Beta Plugin"
24-
![Add plugin](/apps/obsidian/docs/media/add-beta-plugin.png)
24+
![Add plugin](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FdMtstUHPXe.png?alt=media&token=3f139ab9-9802-404d-9554-4a63bac080c5)
2525
4. Enter the repository URL: `https://github.com/blacksmithgu/datacore` and choose "Latest version"
26-
![Add datacore](/apps/obsidian/docs/media/add-datacore.png)
26+
![Add datacore](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FEY3vNGt1Rf.png?alt=media&token=32c60ff1-5272-4cde-8b5f-8f049fb2cf50)
2727
5. Check the box for "Enable after installing the plugin"
2828
6. Click "Add plugin"
2929

@@ -32,10 +32,10 @@ For more information about Discourse Graphs, check out our website at [https://d
3232
1. Open Obsidian Settings
3333
2. Go to "Community Plugins" → "BRAT"
3434
3. Click "Add Beta Plugin"
35-
![Add plugin](/apps/obsidian/docs/media/add-beta-plugin.png)
35+
![Add plugin](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FdMtstUHPXe.png?alt=media&token=3f139ab9-9802-404d-9554-4a63bac080c5)
3636

3737
4. Enter the repository URL: `https://github.com/DiscourseGraphs/discourse-graph-obsidian` and choose "Latest version"
38-
![Add discourse graph](/apps/obsidian/docs/media/add-discourse-graph.png)
38+
![Add discourse graph](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FSBCK-2lkcu.png?alt=media&token=0375c828-da4d-43b4-8f2c-e691692cb019)
3939
5. Check the box for "Enable after installing the plugin"
4040
6. Click "Add Plugin"
4141

@@ -55,77 +55,78 @@ For more information about Discourse Graphs, check out our website at [https://d
5555
- Ensure you have the Templates plugin enabled and configured with a template folder
5656
- The dropdown will show all available template files from your configured template folder
5757

58-
![add node types with template](/apps/obsidian/docs/media/choose-template.png)
58+
![add node types with template](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FHMg_Tq6qiR.png?alt=media&token=69828bfc-c939-41b0-abd4-2cc8931c5a38)
5959
- Click "Save Changes"
6060

6161

6262
- To create a new template:
6363
+ Create new folder to store templates
64-
![new folder](/apps/obsidian/docs/media/new-folder.png)
64+
![new folder](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FyTtJ1a0iI2.png?alt=media&token=b5d09b10-f170-47cd-a239-ee5f7acd89dc)
6565

6666
+ Specify template folder location in plugin settings menu
67-
![template](/apps/obsidian/docs/media/template.png)
67+
![template](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FhzZg_GJXY9.png?alt=media&token=508c8d19-1f13-4fb3-adf1-898dcf694f08)
6868

6969
+ Create new file in template folder (A) and add text to file (B)
70-
![create template file](/apps/obsidian/docs/media/create-template-file.png)
70+
![create template file](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FtTr9vOnXnX.png?alt=media&token=dda1fe25-3ccf-42b4-8f3c-1cd29f82c3f7)
7171

72+
![add node types](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FYRZ6ocI_d-.png?alt=media&token=c623bec7-02bd-42b4-a994-cd1c40a54d82)
73+
- Click "Save Changes"
7274
#### Edit Relation Types
7375
- Under "Relation Types," click "Add Relationship Type"
7476
- A relation type is a kind of relationship that can exist between any two node types
7577
- Enter a name for your relationship (e.g., "supports", "contradicts")
7678
- Enter the complement label (e.g., "is supported by", "is contradicted by")
77-
![add relation type](/apps/obsidian/docs/media/relation-types.png)
79+
![add relation type](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2Fjk367dcO_K.png?alt=media&token=22d74e9f-882c-434b-8b50-afd7a754fb2b)
7880
- Click "Save Changes"
7981
#### Define possible relations between nodes
8082
- Open the Discourse Relations tab in the Discourse Graph settings
81-
![discourse relation](/apps/obsidian/docs/media/discourse-relations.png)
83+
![discourse relation](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FNgm7Ha4Ul5.png?alt=media&token=a933bd3a-d9a6-42c1-9c6e-d779d41c7ebf)
8284
- Choose Source Node Type, Relation Type, and Target Node Type
83-
![choose relation](/apps/obsidian/docs/media/choose-discourse-relations.png)
85+
![choose relation](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FlflJBkfdaK.png?alt=media&token=5de9617c-6099-46e8-931f-feafc604cabb)
8486
- Once you see the source, relation, and target selected:
85-
![final relations](/apps/obsidian/docs/media/final-relation.png)
87+
![final relations](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FycPW-N-rY8.png?alt=media&token=54867be2-9030-4c6c-82d2-b96069e52d81)
8688
E.g: this means that *Claim* nodes can supports *Questions* nodes
87-
<br/>
8889
- Click "Save changes"
8990

9091
## Using Discourse Graphs
9192

9293
### Instantiate a Node
9394

9495
- Select the text you want to turn into a Discourse Node
95-
![select text](/apps/obsidian/docs/media/select.png)
96+
![select text](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FInIer-iPGs.png?alt=media&token=fad214f6-f426-4249-8b0a-d5a403894600)
9697
- There are two ways you can create a node from here:
9798

9899
1. Using command keys: Cmd + \
99100
<br>
100101
- As you press these keys, the Node Menu will open up as a popup
101102

102-
![node menu](/apps/obsidian/docs/media/node-menu.png)
103+
![node menu](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FS6eU6y70eX.png?alt=media&token=00e61ddf-877b-4752-a65b-272e80a0a19c)
103104
- Select the node type you want to turn the text into
104105
- Voila, you've created a new discourse node
105-
![node created](/apps/obsidian/docs/media/node-created.png)
106+
![node created](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2F1VNkJC0aH8.png?alt=media&token=df9a26aa-997b-4b56-a307-87a80e350b28)
106107

107108
2. Right-click menu:
108109
- Alternatively, you can right-click on the selected text
109-
![right click menu](/apps/obsidian/docs/media/right-click-menu.png)
110+
![right click menu](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2F4UqeVkqLz7.png?alt=media&token=d2373152-d251-45fe-afb6-56373d6092aa)
110111
- Then choose a node type from the "Turn into Discourse Node" menu
111112

112113
### Open Discourse Context
113114

114115
- Click on the telescope icon on the left bar
115-
![open discourse context](/apps/obsidian/docs/media/open-dg-context.png)
116+
![open discourse context](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FE10krHZcDM.png?alt=media&token=c1796a9f-7e51-437f-913d-91f5433d9bab)
116117
- Alternatively, you can set a hotkey to toggle the Discourse Context view or access it via the Command Palette
117-
![command palette](/apps/obsidian/docs/media/command.png)
118+
![command palette](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2F5ybScaQISO.png?alt=media&token=2b36f0e7-4247-47b7-a53d-c784dfd4609b)
118119

119120
### Instantiate a Relationship
120121

121122
1. Open a note that you want to create a relationship from
122123
2. Open the Discourse Context
123-
![open discourse context](/apps/obsidian/docs/media/open-dg-context.png)
124+
![open discourse context](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FE10krHZcDM.png?alt=media&token=c1796a9f-7e51-437f-913d-91f5433d9bab)
124125
3. Click "Add a new relation"
125126
4. The dropdown that shows Relationship Types will be all available relations that you have defined in the setings.
126127
<br> It will also show you what node type you can link with
127-
![add relation](/apps/obsidian/docs/media/add-relationship.png)
128+
![add relation](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FXQsgznWuV2.png?alt=media&token=9442b9fa-0904-4847-8eb8-a5791705c4c5)
128129
5. Search the nodes you want to link with by the title
129-
![search](/apps/obsidian/docs/media/search.png)
130+
![search](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2F4NW4UjYDrC.png?alt=media&token=bae307d0-ebec-4e6b-a03d-0943d9d03754)
130131
6. Click "Confirm", now a new relationship has been created
131-
![relationship created](/apps/obsidian/docs/media/relationship-created.png)
132+
![relationship created](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Fdiscourse-graphs%2FK8XAhCqrUL.png?alt=media&token=a559c477-c7f6-4b3e-8b00-ece7da5d4fec)

apps/obsidian/docs/media/BRAT.png

-170 KB
Binary file not shown.
-689 KB
Binary file not shown.
-473 KB
Binary file not shown.
-426 KB
Binary file not shown.
-263 KB
Binary file not shown.
-80.3 KB
Binary file not shown.
-295 KB
Binary file not shown.
-53.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)