search

nuts-foundation / nuts-node

The reference implementation of the Nuts specification. A decentralized identity network based on the w3c ssi concepts with practical functionality for the healthcare domain.
https://nuts-foundation.gitbook.io
GNU General Public License v3.0
23 stars 15 forks source link

check documentation for broken cross references #2952

Closed gerardsn closed 4 months ago

gerardsn commented 5 months ago

With the cleanup of all documentation we are bound to have broken some links. Some may need to reference the wiki and some may need to be removed.

woutslakhorst commented 5 months ago

readthedocs warnings: https://[readthedocs.org/api/v2/build/23884719.txt](https://readthedocs.org/api/v2/build/23884719.txt)

woutslakhorst commented 5 months ago

extracted warnings:

/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/index.rst:26: WARNING: toctree contains reference to nonexisting document 'pages/deployment/custom-credentials'
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/index.rst:26: WARNING: toctree contains reference to nonexisting document 'pages/deployment/administering-your-node'
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/index.rst:26: WARNING: toctree contains reference to nonexisting document 'pages/deployment/backup-restore'
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/monitoring.rst:135: CRITICAL: Title level inconsistent:

Configuration
=============
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/monitoring.rst:165: CRITICAL: Title level inconsistent:

Exported metrics
================
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/storage.rst:58: WARNING: Title underline too short.

HashiCorp Vault
==============
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/storage.rst:58: WARNING: Title underline too short.

HashiCorp Vault
==============
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/verifiable-credentials.rst:12: ERROR: Unknown target name: "verifiable credential issuance (openid4vci)<https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html>".
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/integrating/api-authentication.rst:31: ERROR: Error in "code-block" directive:
maximum 1 argument(s) allowed, 49 supplied.

.. code-block:: yaml
    http:
      internal:
        auth:
          type: token_v2                                 # enables authentication
          authorizedkeyspath: /opt/nuts/authorized_keys  # path to the file containing public keys that are allowed to authenticate.
                                                         # JWTs must be signed with a key registered in this file,
          audience: nuts-node.example.com                # audience for the JWT, defaults to the machine's host name
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/integrating/api-authentication.rst:87: WARNING: Title underline too short.

Generating ``authorized_keys`` file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:132: ERROR: Unexpected indentation.
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:134: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:140: ERROR: Unexpected indentation.
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:141: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:276: CRITICAL: Title level inconsistent:

================
Breaking changes
================
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:281: WARNING: Title overline too short.

***********************
Coconut update (v5.0.10)
***********************
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:281: WARNING: Title overline too short.

***********************
Coconut update (v5.0.10)
***********************
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:426: CRITICAL: Title level inconsistent:

================
Breaking changes
================
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:597: CRITICAL: Title level inconsistent:

=======================
Features / improvements
=======================
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:603: CRITICAL: Title level inconsistent:

================
Dropped features
================
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:610: CRITICAL: Title level inconsistent:

===================
Deprecated features
===================
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:622: CRITICAL: Title level inconsistent:

========
Bugfixes
========
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/technology/saas.rst:31: ERROR: Unexpected indentation.
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/technology/security_model.rst:60: ERROR: Unexpected indentation.
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/technology/security_model.rst:61: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/client_options.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/verifiable-credentials.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done

/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/configuration.rst:83: WARNING: undefined label: 'configure-node'
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/discovery.rst:27: WARNING: Lexing literal_block 'GET /internal/discovery/v1/discovery/coffeecorner/?credentialSubject.name=John%20Doe' as "http" resulted in an error at token: 'G'. Retrying in relaxed mode.
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/discovery.rst:42: WARNING: Lexing literal_block 'POST /internal/discovery/v1/coffeecorner/did:web:example.com' as "http" resulted in an error at token: 'P'. Retrying in relaxed mode.
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/deployment/discovery.rst:67: WARNING: Lexing literal_block 'https://<host>/discovery/<service_id>' as "http" resulted in an error at token: 'h'. Retrying in relaxed mode.
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/getting-started/1-running-docker.rst:10: WARNING: undefined label: 'configure-node'
/home/docs/checkouts/readthedocs.org/user_builds/nuts-node/checkouts/latest/docs/pages/release_notes.rst:539: WARNING: undefined label: 'tls-configuration'
reinkrul commented 4 months ago

All broken stuff fixed.