search

OS2fleetoptimiser / OS2fleetoptimiser-project-setup

Issue tracker repository for getting OS2Fleetoptimiser onboarded to OS2 using GitHub
Creative Commons Zero v1.0 Universal
0 stars 0 forks source link

🧬 Setup source-code repository and make first commit #6

Open janhalen opened 3 weeks ago

janhalen commented 3 weeks ago

To get started quickly without too many manual tasks, the standard OS2 project template should be cloned and used as a starting point for the monorepo source code repository in os2fleetoptimiser

andreasDroid commented 1 week ago

Hi @janhalen, I assume this repo is simply used to track issues, and we should be pushing the code to the (for now) private repo: OS2fleetoptimiser.

Looking at the OS2 compliance project, they have a dedicated repo for docs. Is that also the intention that the FleetOptimiser project gets a dedicated repo for the documentation?

Confusion stems from the fact that we've been using sphinx directly in code base for generating automated documentation from the docstrings. In addition, we have been playing around with automated swagger documentation for our API code.

janhalen commented 1 week ago

Great questions @andreasDroid!

Let me try to make it a bit clearer.

The seperate repo is created from this template: https://github.com/OS2offdig/os2-docs-template that you are free to use.

The main intention is to offload the task of hosting an online, searchable web edition of the docs into our OS2 Github organisation. Its using jekyll and github pages for achieving this, but there is no limits to where the markdown content can originate from.

It sounds great to have some of the sources be automated as you describe. I guess the way your pipeline intends to serve the results of your docs needs to be taken into account, but if it is possible to just generate an organised sturcture of markdown files, then just on top of my head, a simple solution could be to add your sphinx doc result folder as a submodule in the docs repo? But lets talk about the possible technical solutions..

The goal is to have all the technical docs built and hosted alongside the code in the github, making it independent of any supplier CI or municipality webservers.