Skip to content

Commit

Permalink
fix: links, build
Browse files Browse the repository at this point in the history
  • Loading branch information
utnapischtim committed Mar 29, 2024
1 parent 8ed7a0b commit 7331222
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 36 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Set up Python 3.9
uses: actions/setup-python@v2
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: 3.9
python-version: 3.12

- name: Install dependencies
run: |
Expand All @@ -41,6 +41,6 @@ jobs:
run: mkdocs build --strict

- name: Check links
uses: untitaker/[email protected].27
uses: untitaker/[email protected].32
with:
args: site/ --sources docs/
2 changes: 1 addition & 1 deletion docs/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ articles, and such.

InvenioRDM is used all over the world, but not yet translated to all languages.
You can make InvenioRDM even more accessible by joining the translation team
and helping with translations. Follow the guide [here](translators-guide).
and helping with translations. Follow the guide [here](translators-guide.md).

### Submit Feedback

Expand Down
4 changes: 2 additions & 2 deletions docs/deploy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ when planning how to deploy InvenioRDM.
This section assumes you have a good understanding of the different
services that are needed to run an InvenioRDM application, and how they
interact with each other. This information can be found in the
[infrastructure architecture](../develop/architecture/infrastructure/).
[infrastructure architecture](../develop/architecture/infrastructure.md).

## Deployment models

Expand Down Expand Up @@ -181,4 +181,4 @@ If the problem is in the InvenioRDM Python application, you can get more details
in Sentry. Afterwards, you can try to reproduce it and debug in a local
installation.

For more information see the [how to debug section](../develop/getting-started/debugging/).
For more information see the [how to debug section](../develop/getting-started/debugging.md).
2 changes: 1 addition & 1 deletion docs/develop/howtos/custom_fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

*Introduced in InvenioRDM v10*

This guide describes how to create your own custom field. If you have not done it yet, please read first about configuring [records custom fields](../../../customize/metadata/custom_fields/records).
This guide describes how to create your own custom field. If you have not done it yet, please read first about configuring [records custom fields](../../customize/metadata/custom_fields/records.md).
The new custom field in this example will extend the use case described in the records custom field documentation:

_When uploading a research preprint at CERN, I want to record the title and the research program of the related CERN experiments._
Expand Down
4 changes: 2 additions & 2 deletions docs/install/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ You'll find the latest released version number on [PyPi](https://pypi.org/projec

### Commands reference

For a full reference of available commands, see the [CLI reference](/reference/cli/)
For a full reference of available commands, see the [CLI reference](../reference/cli.md)


!!! tip "Shell tab completion"
Invenio-CLI has support for Shell tab completion of commands. See [Shell completion](/reference/cli/#shell-completion).
Invenio-CLI has support for Shell tab completion of commands. See [Shell completion](../reference/cli.md#shell-completion).
2 changes: 1 addition & 1 deletion docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ These guides are intended for advanced users, administrators and developers that
## Guides

- **[CLI](cli.md)**: A reference guide to the commands provided by the Invenio-CLI tool.
- **[Configuration](configuration)**: A reference guide for the configuration variables in InvenioRDM.
- **[Configuration](configuration.md)**: A reference guide for the configuration variables in InvenioRDM.
- **[Metadata Reference](metadata.md)**: A reference guide for the internal metadata schema of bibliographic records in InvenioRDM.
- **[OAI-PMH](oai_pmh.md)**: A reference guide for the OAI-PMH functionality which InvenioRDM exposes.
- **[REST API](rest_api_index.md)**: A reference guide for all the REST APIs that InvenioRDM exposes.
Expand Down
2 changes: 1 addition & 1 deletion docs/releases/upgrading/upgrade-v3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ If unsure, run `invenio-cli install` from inside the instance directory before e
!!! warning "Upgrade from v1 to v2"

If you are upgrading an instance, that you previously upgrade from v1, please
check the [troubleshooting section](/releases/upgrading/upgrade-v2.0/#troubleshooting) for
check the [troubleshooting section](upgrade-v2.0.md#troubleshooting) for
errors that were discovered in the v1 to v2 upgrade.

## Upgrade Steps
Expand Down
2 changes: 1 addition & 1 deletion docs/releases/upgrading/upgrade-v6.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ either free text, which will require no action on your side, contain a ROR
identifier or that they should be a custom vocabulary.

If the affiliations contain ROR identifiers, you will need to add that
vocabulary. See more details [here](../../../customize/vocabularies/affiliations/). Otherwise, you will need to create a
vocabulary. See more details [here](../../customize/vocabularies/affiliations.md). Otherwise, you will need to create a
custom vocabulary in a similar fashion that was done for the subjects above,
or fix your records (remove the identifiers so only the name is preserved).

Expand Down
2 changes: 1 addition & 1 deletion docs/releases/versions/version-v3.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The backend works not only for DOIs but for any other external or internal persi

**Using the new feature**

Check the [documentation](/customize/dois/) to see how to enable and configure the feature. Note that you'll need a testing account with DataCite to complete this. If you don't have that, you can check the demo site, where we have the DOI feature enabled.
Check the [documentation](../../customize/dois.md) to see how to enable and configure the feature. Note that you'll need a testing account with DataCite to complete this. If you don't have that, you can check the demo site, where we have the DOI feature enabled.

**Known issues and future developments**

Expand Down
6 changes: 3 additions & 3 deletions docs/releases/versions/version-v4.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ InvenioRDM can now easily integrate with external authentication providers. You

![](v4.0/sso1.png)

Read the [Authentication](/customize/authentication/) documentation section to get to know how to set it up.
Read the [Authentication](../../customize/authentication.md) documentation section to get to know how to set it up.

SAML integration is also supported, but it requires a more advanced setup.

Expand All @@ -44,14 +44,14 @@ After the first login with an external authentication provider, InvenioRDM can n

When only one external authentication provider is configured, InvenioRDM can be configured to skip the login page and automatically redirect to the external login page.

The [detailed documentation](/customize/authentication/) describes how a new OAuth plugin integration can be implemented.
The [detailed documentation](../../customize/authentication.md) describes how a new OAuth plugin integration can be implemented.


### Vocabularies

This month we continued work on vocabularies. Most notably we migrated the resource types from the old to the new vocabulary and made them easily customizable.

Read more about this [here](/customize/vocabularies/).
Read more about this [here](../../customize/vocabularies/index.md).

#### Facets labelling

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ nav:
- Version v2.0.0: releases/versions/version-v2.0.0.md
- Version v1.0.0: releases/versions/version-v1.0.0.md
- Upgrade guide:
- Upgrade from v11 to v12: releases/upgrading/upgrade-v12.0.md
- Upgrade policy: releases/upgrading/index.md
- Upgrade from v10 to v11: releases/upgrading/upgrade-v11.0.md
- Upgrade from v9 to v10: releases/upgrading/upgrade-v10.0.md
Expand Down
5 changes: 2 additions & 3 deletions run-tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
# Invenio-Cli is free software; you can redistribute it and/or modify it
# under the terms of the MIT License; see LICENSE file for more details.

npx markdownlint-cli docs/* && \
awesome_bot --allow-dupe --skip-save-results --allow-redirect docs/**/*.md && \
# npx markdownlint-cli --config .markdownlint.yaml docs/*
mkdocs build -v
rm -rf site/
# rm -rf site/
18 changes: 3 additions & 15 deletions theme/frontpage_base.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,9 @@
{% endif %}
{% endblock %}
{% block styles %}
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.1118c9be.min.css' | url }}">
{% if config.theme.palette %}
{% set palette = config.theme.palette %}
<link rel="stylesheet" href="{{ 'assets/stylesheets/palette.ba0d045b.min.css' | url }}">
{% if palette.primary %}
{% import "partials/palette.html" as map %}
{% set primary = map.primary(
palette.primary | replace(" ", "-") | lower
) %}
<meta name="theme-color" content="{{ primary }}">
{% endif %}
{% endif %}
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.7e359304.min.css' | url }}">
<link rel="stylesheet" href="{{ 'assets/stylesheets/palette.06af60db.min.css' | url }}">
<meta name="theme-color" content="{{ primary }}">
{% endblock %}
{% block libs %}{% endblock %}
{% block fonts %}
Expand Down Expand Up @@ -169,9 +160,6 @@
{% endif %}
{% endif %}
{% endblock %}
{% block disqus %}
{% include "partials/integrations/disqus.html" %}
{% endblock %}
</article>
</div>
</div>
Expand Down

0 comments on commit 7331222

Please sign in to comment.