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

Remove https://pkiraly.github.io/qa-catalogue-web/ #202

Closed
nichtich opened this issue Jun 19, 2024 · 4 comments
Closed

Remove https://pkiraly.github.io/qa-catalogue-web/ #202

nichtich opened this issue Jun 19, 2024 · 4 comments
Assignees
Labels

Comments

@nichtich
Copy link
Collaborator

The gh-pages branch is outdated and is not maintained. We should aim for one single source of documentation and possibly generate multiple output from there.

@pkiraly
Copy link
Owner

pkiraly commented Jun 19, 2024

I removed the URL, now i returns 404 error. I disabled the building of the branch. I did not emptied however the branch.

What would be your suggestion for the documentation? Do you have a good example in mind?

We maintain READMEs, however right now the backend README is quite complex. We also have some wiki pages, but only because to not add those text to README. So if we decide a new tarteg for the documentation, these could be the sources.

@pkiraly pkiraly self-assigned this Jun 19, 2024
@pkiraly pkiraly added the status:testable Testable label Jun 19, 2024
@nichtich
Copy link
Collaborator Author

An option would be to create a handbook for all of qa-catalogue, written with quarto, and reduce each README to one page, linking to the handbook. But this is work and time is limited!

@pkiraly
Copy link
Owner

pkiraly commented Jun 20, 2024

quarto sounds good. What do you think about the practicalities: would it require to create a new repository (e.g. qa-catalogue-handbook), or should we use a branch of existing repo (e.g. qa-catalogue)?

@nichtich
Copy link
Collaborator Author

It should better be a new repository because it should cover multiple source code repositories. The book can bue build and published via GitHub Action as we do here - I could create a boilerplate but only after vacation in three weeks.

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

No branches or pull requests

2 participants