Skip to content

Commit

Permalink
chore: Migrate CONTRIBUTING & related to Obsidian Publish (#1709)
Browse files Browse the repository at this point in the history
* chore: Initial commit of new 'contributing' vault

See #1705

* chore: Remove accidental newline

* chore: Copy CONTRIBUTING.md to contributing/, ready to split up.

* chore: Remove Contents list from CONTRIBUTING.md

As I am about to divide the file up in to smaller sections.

* chore: Remove collapsing of 2 sections in CONTRIBUTING.md

This will not be necessary when the sections are divided up.

* chore: Move markdownlint-disable to the section where it is needed

* chore: Install and configure "note-refactor-obsidian" plugin

* chore: Make missing H1 lines visible in Obsidian

By turning off the showing of the inline title.

* chore: Stop IDEs fighting with Obsidian over EOLs on JSON files

* chore: Set Light/Dark theme to 'Adapt to System'

Because I want it White on my machine, but others may differ.

* chore: Remove EOLs added by editorconfig settings previously

* chore: Split CONTRIBUTING.md at level-2 headings

And fix markdownlint issues

* feat: Publish contributing/ to https://publish.obsidian.md/tasks-contributing/

* chore: Install and enable "obsidian-dangling-links" plugin

* chore: Link to GitHub for files outside contributing/

* chore: Remove unnecessary './' from link text

* chore: Fix internal links, from GitHub to Obsidian style

* chore: Move files down in to their own sections

* chore: Move Local setup and workflow for changes to code and tests.md

* chore: Split up pages in to sections

* chore: Show line numbers in Obsidian and use strict line breaks.

I have also edited the Publish settings to enable strict line breaks.
This mirrors the way markdown files were rendered on GitHub.

* chore: Add settings for "obsidian-dangling-links" plugin

* chore: Note pages specific to Jekyll & GitHub pages docs

* chore: Prepare to add publish docs/README.md content

Start by copying the old docs/README.md in to contributing/User Documentation/

* chore: Remove old table of contents from docs-README.md

* chore: Prepare to split docs-README.md

* chore: Prevent Options 1 & 2 ending up in separate files

* chore: Divide up docs-README.md at H2

* chore: Don't prompt on deleting files

* chore: Delete docs-README.md

* chore: Fix links left over GitHub rendering days.

* chore: Tell Obsidian to always update links when renaming files

* chore: Rename 'User Documentation/' to 'Documentation/'

* chore: Rename 'Developing the plugin/' to 'Building/'

* chore: Move some Howtos to specific folders

* chore: Move 'Updating code' to new new 'Contributing' section

* chore: Delete contributing/CONTRIBUTING.md

It has totally been replaced by the separate pages.

* chore: Provide 'About' pages in every directory

* chore: 'Rename Thank you.md' to 'Welcome.md'

This will become the new starting point for this vault and site.

* chore: Improve the starting experience

* chore: Add some colours to the Graph

* chore: Improve some internal links

* chore: Improve About Testing.md

* chore: Improve 'About Testing.md'

* chore: Add link to the Tasks repo in Welcome.md

* chore: Tell users how to read the contributing docs

And align links in a rather untidy list.

* chore: Update CONTRIBUTING.md and README.md to point to new site

These are the pages whose old content was migrated to Obsidian Publish.

See #1705.
  • Loading branch information
claremacrae authored Feb 28, 2023
1 parent 8f6b58b commit d388a22
Show file tree
Hide file tree
Showing 62 changed files with 11,158 additions and 872 deletions.
2 changes: 2 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ indent_size = 2

[*.json]
indent_size = 2
# Stop IDEs adding newlines to end of Obsidian .json config files:
insert_final_newline = false

[*.{yml,yaml}]
indent_size = 2
Expand Down
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ yarn-error.log
# asdf
.tool-versions

# files in sample vaults
/resources/sample_vaults/Tasks-Demo/.obsidian/workspace
/resources/sample_vaults/Tasks-Demo/.obsidian/workspace.json
# files in local vaults
**/workspace
**/workspace.json
.hotreload

# Backup files.
Expand Down
733 changes: 3 additions & 730 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions contributing/.obsidian/app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"showInlineTitle": false,
"showLineNumber": true,
"strictLineBreaks": true,
"promptDelete": false,
"alwaysUpdateLinks": true
}
4 changes: 4 additions & 0 deletions contributing/.obsidian/appearance.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"accentColor": "",
"theme": "system"
}
4 changes: 4 additions & 0 deletions contributing/.obsidian/community-plugins.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[
"note-refactor-obsidian",
"obsidian-dangling-links"
]
29 changes: 29 additions & 0 deletions contributing/.obsidian/core-plugins-migration.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"file-explorer": true,
"global-search": true,
"switcher": true,
"graph": true,
"backlink": true,
"canvas": true,
"outgoing-link": true,
"tag-pane": true,
"page-preview": true,
"daily-notes": true,
"templates": true,
"note-composer": true,
"command-palette": true,
"slash-command": false,
"editor-status": true,
"starred": true,
"markdown-importer": false,
"zk-prefixer": false,
"random-note": false,
"outline": true,
"word-count": true,
"slides": false,
"audio-recorder": false,
"workspaces": false,
"file-recovery": true,
"publish": true,
"sync": false
}
21 changes: 21 additions & 0 deletions contributing/.obsidian/core-plugins.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[
"file-explorer",
"global-search",
"switcher",
"graph",
"backlink",
"canvas",
"outgoing-link",
"tag-pane",
"page-preview",
"daily-notes",
"templates",
"note-composer",
"command-palette",
"editor-status",
"starred",
"outline",
"word-count",
"file-recovery",
"publish"
]
79 changes: 79 additions & 0 deletions contributing/.obsidian/graph.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
{
"collapse-filter": true,
"search": "",
"showTags": false,
"showAttachments": false,
"hideUnresolved": false,
"showOrphans": true,
"collapse-color-groups": false,
"colorGroups": [
{
"query": "path:Building/",
"color": {
"a": 1,
"rgb": 14048348
}
},
{
"query": "path:Contributing/",
"color": {
"a": 1,
"rgb": 14069084
}
},
{
"query": "path:Debugging/",
"color": {
"a": 1,
"rgb": 16771584
}
},
{
"query": "path:Dependencies/",
"color": {
"a": 1,
"rgb": 5943130
}
},
{
"query": "path:FAQs/",
"color": {
"a": 1,
"rgb": 10417624
}
},
{
"query": "path:Releases/",
"color": {
"a": 1,
"rgb": 6073814
}
},
{
"query": "path:Testing/",
"color": {
"a": 1,
"rgb": 6053078
}
},
{
"query": "path:Documentation/",
"color": {
"a": 1,
"rgb": 11361494
}
}
],
"collapse-display": false,
"showArrow": true,
"textFadeMultiplier": -3,
"nodeSizeMultiplier": 1,
"lineSizeMultiplier": 2.3215087890625,
"collapse-forces": false,
"centerStrength": 0.555745442708333,
"repelStrength": 19.4970703125,
"linkStrength": 1,
"linkDistance": 490,
"scale": 0.5478683072897571,
"close": false
}
1 change: 1 addition & 0 deletions contributing/.obsidian/hotkeys.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
11 changes: 11 additions & 0 deletions contributing/.obsidian/plugins/note-refactor-obsidian/data.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"includeFirstLineAsNoteHeading": false,
"excludeFirstLineInNote": false,
"headingFormat": "#",
"newFileLocation": 1,
"customFolder": "",
"fileNamePrefix": "",
"transcludeByDefault": false,
"noteLinkTemplate": "",
"refactoredNoteTemplate": ""
}
Loading

0 comments on commit d388a22

Please sign in to comment.