From d92d4127af11405a3a7be46bbb7cd010446ffef8 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Wed, 31 May 2023 08:49:09 -1000 Subject: [PATCH] ;cln:doc: convert .html links to .md (which work in Obsidian) --- doc/COMMITS.md | 4 ++-- doc/CONTRIBUTING.md | 10 +++++----- doc/FILES.md | 6 +++--- doc/PULLREQUESTS.md | 2 +- doc/RELEASING.md | 6 +++--- doc/WORKFLOWS.md | 4 ++-- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/COMMITS.md b/doc/COMMITS.md index 65aa5534d..3940d952b 100644 --- a/doc/COMMITS.md +++ b/doc/COMMITS.md @@ -20,7 +20,7 @@ Here's the typical format: More precisely: - Commit messages must begin with one or more prefixes (colon-terminated words), - indicating the type and/or [topic](ISSUES.html#topics). + indicating the type and/or [topic](ISSUES.md#topics). - Commits causing user-visible changes must begin with `feat:`, `imp:` or `fix:` (feature, improvement, or bugfix). These will be used in release notes. If they are breaking/incompatible changes, use `feat!:`, `imp!:` or `fix!:`. @@ -51,7 +51,7 @@ Some possible prefixes: - `doc` - documentation-related - `test` - tests-related - `ci` - continuous integration-related -- Any of the standard [labels](ISSUES.html#labels) used in the issue tracker. +- Any of the standard [labels](ISSUES.md#labels) used in the issue tracker. ## How to check commits diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index 08834c69b..7f3485bcc 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -10,8 +10,8 @@ Browse the ideas below, or say hello in the chat and we'll help find you a job. ## First steps -- Join the [#hledger chat](support.html), best place for quick help and feedback -- Skim the [FAQs](faq.html) +- Join the [#hledger chat](support.md), best place for quick help and feedback +- Skim the [FAQs](faq.md) ## Ideas for contributing as a ... @@ -25,8 +25,8 @@ Browse the ideas below, or say hello in the chat and we'll help find you a job. ### Developer -- See the [Developer workflows](WORKFLOWS.html) -- and other [Developer docs](dev.html) +- See the [Developer workflows](WORKFLOWS.md) +- and other [Developer docs](dev.md) ### Developer using the hledger libraries @@ -76,7 +76,7 @@ When reporting bugs, don't forget to search the tracker for a similar bug report Otherwise, open a new bug by clicking "New issue", or . Enhancement requests are sometimes added to the tracker,but for these consider using -the IRC channel and mail list (see [Getting help](index.html#getting-help)). +the IRC channel and mail list (see [Getting help](index.md#getting-help)). Both are archived and linkable, so the idea won't be lost. There is also a collection of wishes at the old [trello board](http://trello.hledger.org). diff --git a/doc/FILES.md b/doc/FILES.md index b15d4cc0b..9ea55f70b 100644 --- a/doc/FILES.md +++ b/doc/FILES.md @@ -11,7 +11,7 @@ Some views and explanations of files in the hledger project, as of 2022-12. ## hledger working copy -A full working copy of the official hledger [repos](REPOS.html) +A full working copy of the official hledger [repos](REPOS.md) is best laid out like this (manually; we currently don't use git submodules): 
 src/hledger/ - git clone https://github.com/simonmichael/hledger; cd hledger
@@ -188,7 +188,7 @@ src/hledger/finance/
 
 ## hledger user scripts
 
-[Scripts](scripts.html) for users are in bin/:
+[Scripts](scripts.md) for users are in bin/:
 
 
 
@@ -498,8 +498,8 @@ src/hledger/site/src/
   VERSIONNUMBERS.md
   WORKFLOWS.md
   accounting.md
-  add.md
   balancing-the-accounting-equation.md
+  basics.md
   beancount.md
   budgeting-and-forecasting.md
   budgeting.md
diff --git a/doc/PULLREQUESTS.md b/doc/PULLREQUESTS.md
index f6199bea5..4ac8dab61 100644
--- a/doc/PULLREQUESTS.md
+++ b/doc/PULLREQUESTS.md
@@ -70,7 +70,7 @@ Rebase your commits against latest master for easiest review. Especially if they
 
 We like to use some conventions in commit messages when it makes sense. These aren't mandatory, but appreciated:
 
-- prepend a [label](ISSUES.html#labels) prefix, eg `cli: ` or `journal: `, for clarity and to help with changelog production
+- prepend a [label](ISSUES.md#labels) prefix, eg `cli: ` or `journal: `, for clarity and to help with changelog production
 - prepend a semicolon (`;`) to indicate commits that 
   - need not trigger a CI workflows, reducing wasteful carbon emissions
   - and probably need not be mentioned in changelogs/release notes
diff --git a/doc/RELEASING.md b/doc/RELEASING.md
index 0d67e1e6f..969cb4a1e 100644
--- a/doc/RELEASING.md
+++ b/doc/RELEASING.md
@@ -114,7 +114,7 @@ To do a release, start at the bottom of the diagram and work up
 - Make things a little better each time through: simpler, more reliable, better documented, more automated, easier, faster, cheaper, higher quality.
 - `make`, `./Shake` and `./bake`.
 - Update changelogs early and often, eg during/after a PR, to spread the work. 
-  See also [CHANGELOGS](CHANGELOGS.html).
+  See also [CHANGELOGS](CHANGELOGS.md).
 - Do releases from a release branch, not from master.
 - All platform binaries should be built from the same commit, the one with the release tags.
 - Binaries' --version shows their git hash and build date; these should match the release tag and release date.                                                   
@@ -181,7 +181,7 @@ Bugfix/fixup release:
 Preview/major release:
 - `PAUSE=1 ECHO=1 ./bake prep MA.JOR[.99.PREVIEWNUM]` (eg 1.24.99.1 for 1.25 preview 1)
   (XXX seems to go wrong without PAUSE`)
-- clean up changelogs, amend changelogs commit (see also [CHANGELOGS](CHANGELOGS.html))
+- clean up changelogs, amend changelogs commit (see also [CHANGELOGS](CHANGELOGS.md))
 - cherry pick changes from master (if needed)
   - list changes in three side-by-side magit windows
     - 1. NEW IN MASTER: `l o MAJORVER-branch..master`, `M-x magit-toggle-buffer-lock`, `M-x toggle-window-dedicated` (`C-c D`)
@@ -374,7 +374,7 @@ In release branch:
 #### Merge release branch changes to master
 - switch back to master
 - check out release branch in another working copy (hledger2)
-- manually merge release changelogs into master changelogs (see also [CHANGELOGS](CHANGELOGS.html))
+- manually merge release changelogs into master changelogs (see also [CHANGELOGS](CHANGELOGS.md))
 - list commits only in release branch: magit `l o master..MA.JOR-branch`
 - cherry-pick any other useful commits
 
diff --git a/doc/WORKFLOWS.md b/doc/WORKFLOWS.md
index da5a112c5..626252573 100644
--- a/doc/WORKFLOWS.md
+++ b/doc/WORKFLOWS.md
@@ -37,7 +37,7 @@ Eg:
 - review and discuss new [pull requests](http://prs.hledger.org) and commits on github
 - build hledger and test the latest changes in your own repo
 - read the existing [code docs and source](#quick-links)
-- send feedback or discuss via [IRC or mail list](support.html)
+- send feedback or discuss via [IRC or mail list](support.md)
 
 ## Build in place
 
@@ -179,7 +179,7 @@ If you're new to this process, [help.github.com](https://help.github.com) may be
 
 ## Add yourself to the contributor list
 
-- after getting something into the master branch, read and sign the [contributor list & agreement](https://hledger.org/contributors.html). Or, [ask](support.html) to be added.
+- after getting something into the master branch, read and sign the [contributor list & agreement](https://hledger.org/contributors.html). Or, [ask](support.md) to be added.
 - give yourself a high five!
 
 ## Work on docs