Skip to content

Commit

Permalink
Fix links to markdown link checker
Browse files Browse the repository at this point in the history
This shouldn't have been nessary for paths but seems fine.
  • Loading branch information
BryanQuigley committed Jan 29, 2025
1 parent 5f1e6f5 commit d1f826f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions .mega-linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ DISABLE:
DISABLE_LINTERS:
- YAML_V8R
- SPELL_LYCHEE
- MARKDOWN_MARKDOWNLINT
PRINT_ALL_FILES: false
DOCKERFILE_HADOLINT_ARGUMENTS: "--ignore DL3008 --ignore DL4006 --ignore DL3009 --ignore DL3059"
SHOW_ELAPSED_TIME: true
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ JKAN is a [Jekyll](http://jekyllrb.com/) site that uses JavaScript for enhanced
| `_data/licenses.yml` | A list of licenses that datasets can be associated with |
| `_datasets` | A directory of `.md` files containing dataset information in YAML front-matter |
| `_dataset_categories` | A directory of `.md` files containing dataset categories in YAML front-matter |
| `_includes` | HTML partials that are included in layouts. `display` is used by [schema files](/docs/configuration.md) |
| `_includes` | HTML partials that are included in layouts. |
| `_layouts` | Page templates |
| `_organizations` | A directory of `.md` files containing organization information in YAML front-matter |
| `editor` | Configuration for the Editor UI, described below |
Expand Down
8 changes: 4 additions & 4 deletions docs/upgrading.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Upgrading
See [release notes](/releases) for details of what's changed between versions.
See [release notes](https://github.com/timwis/jkan/releases) for details of what's changed between versions.

## For every upgrade
If your JKAN repository is a fork, you should see a banner at the top of the repository saying, e.g. "This branch is 20 commits ahead, 32 commits behind timwis:gh-pages". Clicking on the "X commits behind" link should take you to a page where you can initiate a pull request, which should show you the changes that will be applied to your repository. It should take you to:
Expand All @@ -12,11 +12,11 @@ If there are no conflicting changes in your fork, you'll be able to merge the pu

## v1.x to v2.0
- If you use the editing UI
- You'll need to switch to the new editing UI, powered by Decap CMS. You don't need to host your JKAN site on Netlify to do so. Follow the [installation](installation) instructions to setup the OAuth integration.
- You'll need to switch to the new editing UI, powered by Decap CMS. You don't need to host your JKAN site on Netlify to do so. Follow the [installation](installation.md) instructions to setup the OAuth integration.
- If you have custom categories
- You'll need to convert `_data/categories.yml` into a collection (a directory of files) in the `_dataset_categories` directory. See the [sample categories](/_dataset_categories) for the format. You should delete `_data/categories.yml` afterwards.
- You'll need to convert `_data/categories.yml` into a collection (a directory of files) in the `_dataset_categories` directory. See the [sample categories](../_dataset_categories/) for the format. You should delete `_data/categories.yml` afterwards.
- If you have custom licenses
- We've also changed the structure of `_data/licenses.yml`. If you've customised that file at all, you'll need to update the structure to match the [new format](/_data/licenses.yml) as well.
- We've also changed the structure of `_data/licenses.yml`. If you've customised that file at all, you'll need to update the structure to match the [new format](../_data/licenses.yml) as well.
- If you have customised templates
- Replace any references to `site.data.categories` with `site.dataset_categories`
- Replace any references to `site.data.licenses` with `site.data.licenses.items`
Expand Down

0 comments on commit d1f826f

Please sign in to comment.