Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Restructure and update landing page content #175

Merged
merged 8 commits into from
Aug 8, 2023

Conversation

duncandewhurst
Copy link
Contributor

@duncandewhurst duncandewhurst commented Aug 6, 2023

Related issues

Description

This PR implements the structure and landing page content proposed in #43 (comment). Notably, that includes integrating the content from the old taxonomies and GED4ALL pages into the 'other standards' page and linking to it from the relevant sections of the codelist and schema reference pages. It also includes a first draft of content for the new pages in the introduction section: 'What is the RDLS?' and 'How do I implement the RDLS?'. The latter page will need to be updated once the spreadsheet template and conversion and validation tool are available online and once the how-to guide for publishing RDLS metadata is written.

Merge checklist

  • Update the changelog (style guide)
  • Run ./manage.py pre-commit

If you added or removed a field:

  • Update the collapse option of the jsonschema directives for dataset, resource, hazard, exposure, vulnerability and loss on reference/schema.md

Having trouble?

See how to resolve check failures.

@duncandewhurst
Copy link
Contributor Author

These changes are probably easier to review in the built documentation: https://rdl-standard.readthedocs.io/en/43-restructure/

@duncandewhurst duncandewhurst marked this pull request as ready for review August 7, 2023 01:45
@odscjen
Copy link
Contributor

odscjen commented Aug 7, 2023

@duncandewhurst I merged the latest dev branch into this PR and it's caused a readthedocs failure. Running this on my own machine there was a typo introduced in reference/schema.md but fixing that made the build work properly so I'm not sure why it's now failing here

Copy link
Contributor

@matamadio matamadio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flow of information is more intuitive now.

@duncandewhurst
Copy link
Contributor Author

@duncandewhurst I merged the latest dev branch into this PR and it's caused a readthedocs failure. Running this on my own machine there was a typo introduced in reference/schema.md but fixing that made the build work properly so I'm not sure why it's now failing here

Ah, the reason was that this PR added a new instance of the jsonschema directive on docs/rdl/what.md, which referenced rdl_schema_0.1.json that had been renamed on dev. The reason it built OK locally is because the directive links to the built version of the schema, which would have still been available on your local machine unless you first ran make clean to delete the build folder. Whereas, on Read the Docs, the docs are built on a fresh virtual machine each time. I've fixed the link in 1aece4b

@duncandewhurst
Copy link
Contributor Author

@matamadio are you happy for me to merge this or do you want to wait for @stufraser1 to review?

@duncandewhurst duncandewhurst merged commit 152ae18 into dev Aug 8, 2023
4 checks passed
@duncandewhurst duncandewhurst deleted the 43-restructure branch August 8, 2023 08:27
@duncandewhurst
Copy link
Contributor Author

Agreed to merge in call with @matamadio

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs update] Remove GED4all exposure taxonomy page
3 participants