Transform documentation into Quarto

[pkiraly]

The site's first version is available at https://pkiraly.github.io/qa-catalogue/, but there are several things, that I am not able to solve so far

• quarto render on Ubuntu does not render diagrams (while RStudio does)
• Is it possible to include JavaDoc into the Quarto output?
• How to render CSV snippets?
• The source files are in quarto-docs directory. The target should be a child directory (default is _book). The Github integration document suggests the project's docs directory, but with quarto it is not possible to create output outside of quarto project (output-dir: ../docs), and Github does not allow to use quarto-docs/_book, so the solution is to copy quarto-docs/_book to docs.
• There are some differences between the Mrkdown syntax of Github and Quarto, so there might be some rendering issue
• Should the Web UI's documentation be included?
• How to make it community editable?

[nichtich]

• Quarto should run via GitHub Action and push the result HTML to gh-pages branch (see example) - this would also solve the fourth point with quarto-docs

Should the Web UI's documentation be included?

Every solution has its pros and cons:

a) Everything documented in qa-catalogue
b) Two documentations for qa-catalogue and qa-catalogue-web each
c) Move combined documentation to new repository qa-catalogue-docs
d) Build combined documentation in qa-catalogue but include files from qa-catalogue-web

Is it possible to include JavaDoc into the Quarto output?

No (or yes with custom hacks) and I don't think it is necessary.

[nichtich]

We could also move official URL to a dedicated domain

[nichtich]

The documentation now build with GitHub action (see actions log) and published in gh-pages branch (see https://github.com/pkiraly/qa-catalogue/commits/gh-pages/) but not available at https://pkiraly.github.io/qa-catalogue/ yet. I guess it's either caching issue or the settings of this project need to be changed to where GitHub pages should be take from (not from docs directory but from / at gh-pages branch).

[pkiraly]

Many thanks! I changed the settings, so now it is available at https://pkiraly.github.io/qa-catalogue/.

[nichtich]

Do you (re)move existing content from README.md and INSTALL.md to the docs/ directory?

[pkiraly]

Yes, I will, but 1) I am on business trip, so I can do it some days later 2) I just sent an email to the mailing list, and I would like to have some feedback.