project: import otk

[supakeen]

Import the documentation for otk.

[ochosi]

I guess this isn't ready yet, the import scripts still need to be updated, right?

[supakeen]

I guess this isn't ready yet, the import scripts still need to be updated, right?

What do you mean? There's no need to import the README as the project has a direct index.md. And there's no need to import other things a-la osbuild modules either? :)

[ochosi]

But how will it get updated? (Sorry, maybe I'm missing something obvious)

[supakeen]

But how will it get updated? (Sorry, maybe I'm missing something obvious)

It won't. The documentation will be removed from the otk repository and included here instead much like the documentation for other projects in this repository.

If you want I can adjust this PR to instead use the pipelines to auto pull in the doc/ subdirectory of the otk repository but that's different from how the other pages work here.

We only pull in the README's of a few selected projects and then we autogenerate the content of modules/ under osbuild here.

[ochosi]

But how will it get updated? (Sorry, maybe I'm missing something obvious)

It won't. The documentation will be removed from the otk repository and included here instead much like the documentation for other projects in this repository.

If you want I can adjust this PR to instead use the pipelines to auto pull in the doc/ subdirectory of the otk repository but that's different from how the other pages work here.

We only pull in the README's of a few selected projects and then we autogenerate the content of modules/ under osbuild here.
I don't really agree - we do pull multiple pages per project. That is most of the 'developer guide' pages that this PR also targets.

The goal of the importer was to keep as many of the docs as possible with the code. This should help with getting the docs updated (e.g. how to install) when the project changes.

Is there a reason for otk to deviate from this or am I missing something?

[supakeen]

But how will it get updated? (Sorry, maybe I'm missing something obvious)

It won't. The documentation will be removed from the otk repository and included here instead much like the documentation for other projects in this repository.
If you want I can adjust this PR to instead use the pipelines to auto pull in the doc/ subdirectory of the otk repository but that's different from how the other pages work here.
We only pull in the README's of a few selected projects and then we autogenerate the content of modules/ under osbuild here.
I don't really agree - we do pull multiple pages per project. That is most of the 'developer guide' pages that this PR also targets.

The goal of the importer was to keep as many of the docs as possible with the code. This should help with getting the docs updated (e.g. how to install) when the project changes.

Is there a reason for otk to deviate from this or am I missing something?

There is no deviation here right?

This is following the status quo of how the documentation for osbuild, etc work. Their documents live in this repository; and we only import their READMEs and in the osbuild special case we also pull the module documentation but for example the rest of its docs live in this repository.

Same goes for the "on premises" and "hosted" content though I guess those live across tools.

I'd be happy to expand the github action to instead pull the docs subdirectory directly from otk and place it here if that's how we want to do this in the future.