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

fix(docs): DSP-API docs root route gives a 404 error (DEV-3345) #3073

Merged

Conversation

BalduinLandolt
Copy link
Contributor

Pull Request Checklist

Task Description/Number

For https://docs.dasch.swiss/latest/DSP-API/ (in our combined docs setup - in an isolated setup, this corresponds to the / route) to be available, MkDocs needs a top level index.md file.

Issue Number: DEV-3345

PR Type

  • build/chore: maintenance tasks (no production code change)
  • docs: documentation changes (no production code change)
  • feat: represents new features
  • fix: represents bug fixes
  • perf: performance improvements
  • refactor: represents production code refactoring
  • test: adding or refactoring tests (no production code change)

Basic requirements for bug fixes and features

  • Tests for the changes have been added
  • Docs have been added / updated

Does this PR introduce a breaking change?

  • Yes

Does this PR change client-test-data?

  • Yes

Copy link

linear bot commented Feb 28, 2024

Copy link

codecov bot commented Feb 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.66%. Comparing base (eac5751) to head (89cd26a).
Report is 91 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #3073       +/-   ##
===========================================
+ Coverage   11.74%   88.66%   +76.92%     
===========================================
  Files         246      262       +16     
  Lines       22907    22480      -427     
===========================================
+ Hits         2690    19932    +17242     
+ Misses      20217     2548    -17669     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@BalduinLandolt BalduinLandolt changed the title fix (docs): https://docs.dasch.swiss/latest/DSP-API/ gives a 404 error (DEV-3345) fix (docs): DSP-API docs root route gives a 404 error (DEV-3345) Feb 28, 2024
@BalduinLandolt BalduinLandolt changed the title fix (docs): DSP-API docs root route gives a 404 error (DEV-3345) fix(docs): DSP-API docs root route gives a 404 error (DEV-3345) Feb 28, 2024
Copy link
Contributor

@seakayone seakayone left a comment

Choose a reason for hiding this comment

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

suggestion (non-blocking): Add a small table of contents to the overview

I feel like the current first page https://docs.dasch.swiss/latest/DSP-API/01-introduction/what-is-dsp/ gives a good overview/advertisement of the DSP platform.
Now that we have an actual "Overview" for just the api documentation it might be useful to point to some interesting starting point to dig deeper into the documentation.

Could be a bullet point list which is adding some information to the most interesting pages.
Something like:

Here are some interesting pages to get started:
* DSP Ontologies - An in depth description of data modelling
* DSP-API Endpoints - A user guide on how to interact with our platform with your own clients
* FAQ - Answers to common inquiries presented concisely for quick reference

@seakayone
Copy link
Contributor

praise: Thanks for swiftly solving this problem.

@seakayone seakayone self-requested a review February 29, 2024 07:59
@jnussbaum jnussbaum merged commit 0370e13 into main Feb 29, 2024
13 of 15 checks passed
@jnussbaum jnussbaum deleted the feature/dev-3345-fix-404-on-httpsdocsdaschswisslatestdsp-api branch February 29, 2024 09:16
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.

3 participants