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.

Sign up for GitHub

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

Jump to bottom

[QA]: move docs into separate repo #414

Open
kitsudaiki opened this issue Aug 4, 2024 · 0 comments
Open

[QA]: move docs into separate repo #414

kitsudaiki opened this issue Aug 4, 2024 · 0 comments
Assignees
@kitsudaiki
Labels
Build-Process in case the build-process has to be updated Documentation requires an update of the documentation Infrastructure Issues, which containing infrastructure updates in the webserver, ci-pipeline and so on L: ★★☆ Expect mid difficulty QA Any tasks, witch improve the quality of the code, documentation and so on
Milestone
backlog

Comments

@kitsudaiki
Copy link
Owner

QA

Description

The documentation should be moved into a separate repository. It contains images and this shouldn't blow up this repository even more. Beside this most of the version-critical information like open-api specs are auto-generated from the code anyway.

Acceptance Criteria

  • docs were moved into a separate repository
  • docs are linked as submodule into this repository here
  • the new docs-repo has a markdown-linter within its CI
  • docs are still build within the CI of this repo here

Additional Information

Blocked by

How to test
@kitsudaiki kitsudaiki added QA Any tasks, witch improve the quality of the code, documentation and so on Documentation requires an update of the documentation Build-Process in case the build-process has to be updated Infrastructure Issues, which containing infrastructure updates in the webserver, ci-pipeline and so on L: ★★☆ Expect mid difficulty labels Aug 4, 2024
@kitsudaiki kitsudaiki self-assigned this Aug 4, 2024
@kitsudaiki kitsudaiki added this to the 0.6.0 milestone Aug 4, 2024
@kitsudaiki kitsudaiki modified the milestones: 0.6.0, backlog core Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kitsudaiki kitsudaiki

Labels
Build-Process in case the build-process has to be updated Documentation requires an update of the documentation Infrastructure Issues, which containing infrastructure updates in the webserver, ci-pipeline and so on L: ★★☆ Expect mid difficulty QA Any tasks, witch improve the quality of the code, documentation and so on
Projects
OpenHanami
Status: No status
Milestone
backlog
Development

No branches or pull requests
1 participant
@kitsudaiki