You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, the openpipelines source code and the source quarto .qmd files are split in two repositories. This causes some technical friction when updating the documentation:
When a new version of openpipelines is released, qmd files are rendered and pushed to the website repository using github actions
In the website repository there is a submodule for the openpipeline repo which is used when quarto is executed.
This means that information if flowing two times from the openpipelines repository to the website repository. Additionally, if something in the documentation needs to be changed, it might require either:
A push to the openpipelines repo
A push to the website repo
Changes to to both
A solution to this problem might be to merge the source code for openpipelines and the source code for the website together. The website repository continues to exist, but only to host the rendered htmls. The downsides are that
Care should be taken to make sure that changes in the documentation should not trigger a full build of the components. This could be done with similar code to what we already have
The download size of the repository increases.
This change is not just a copy-paste of the website source code to the openpipelines repo, it might require some work to get everything working again.
The advantages are:
Easier automatic deployment of the documentation
The documentation of openpipelines is versionned together with the pipeline. This could enable a multi-version of the documentation in the future.
Making sure that changes (like updating the viash version) do not cause problems is easier because develop build are possible.
Pull requests for changes in the components/workflows can include changes to the documentation as well, making it easier to keep the documentation up-to-date and gathering all changes in a single PR
The text was updated successfully, but these errors were encountered:
Currently, the openpipelines source code and the source quarto .qmd files are split in two repositories. This causes some technical friction when updating the documentation:
This means that information if flowing two times from the openpipelines repository to the website repository. Additionally, if something in the documentation needs to be changed, it might require either:
A solution to this problem might be to merge the source code for openpipelines and the source code for the website together. The website repository continues to exist, but only to host the rendered htmls. The downsides are that
The advantages are:
The text was updated successfully, but these errors were encountered: