inveniosoftware / docs-invenio-rdm

InvenioRDM docs
https://inveniordm.docs.cern.ch/
MIT License
23 stars 66 forks source link

Added available sort options for all REST API endpoints that allow sorting #612

Closed monotasker closed 5 months ago

monotasker commented 6 months ago

:heart: Thank you for your contribution!

Description

Added documentation on the sort options available for all REST API endpoints that allow sorting.

Checklist

Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:

Third-party code

If you've added third-party code (copy/pasted or new dependencies), please reach out to an architect.

Reminder

By using GitHub, you have already agreed to the GitHub’s Terms of Service including that:

  1. You license your contribution under the same terms as the current repository’s license.
  2. You agree that you have the right to license your contribution under the current repository’s license.
monotasker commented 5 months ago

Okay, I've made the minor changes to default option ordering, removed the table of vocab options (leaving a description of the defaults), and fixed the missing file extensions in the links. Should be good to go.

fenekku commented 5 months ago

Hmm something is off with the links (see https://github.com/inveniosoftware/docs-invenio-rdm/actions/runs/8582061590/job/23563183805?pr=612), but at least one other PR is potentially affected: https://github.com/inveniosoftware/docs-invenio-rdm/actions/runs/8526851030/job/23356983728?pr=614 ... I will add this as something I will look into this month as part of preparations for v12 since we need to make sure docs are good. Can you rebase it to see if that fixes it?

monotasker commented 5 months ago

Okay, I rebased my branch but it doesn't seem to have fixed the issue. When I build the docs locally I get the same error: not from links in the documentation text but because of two missing style files: /assets/stylesheets/main.10ba22f1.min.css and /assets/stylesheets/palette.06af60db.min.css. These are linked in the frontpage_base.html template, and the files do indeed seem to be missing. I don't think this is related to any of my changes. Maybe something happened upstream that is just becoming visible here? (Or maybe I'm missing something!)

fenekku commented 5 months ago

Indeed something is strange. If you don't mind, when I look into it, may I push to your branch to fix it? This will be faster and you've already done the heavy lifting, so you shouldn't have to deal with that structural problem :wink: .

monotasker commented 5 months ago

Sure. No problem

fenekku commented 5 months ago

Merged it here: https://github.com/inveniosoftware/docs-invenio-rdm/pull/619 (@monotasker 's master branch is probably protected so I couldn't push to it). I think Nico fixed the issue by resetting the clean options: https://github.com/inveniosoftware/docs-invenio-rdm/commit/c6e7334fe0a9386d1db42fe499cd5c53947be556#diff-1db27d93186e46d3b441ece35801b244db8ee144ff1405ca27a163bfe878957fR41 . Kind of strange nevertheless.

Thank you!