Website concept #50

Open
opened 4 months ago by kai.boesefeldt · 0 comments
Collaborator

The odo website is fed from different sources:

All these resources are related to a specific branch. They are "compiled" using the _build script in the jekyll folder on a the branch, which in turn generates html files in the pages repository (which contains the web site).

However, from the perspective of the development process, I may want to have different sources for this information:

  • A general frame containing the project name, links to the most important resources (repository, issues, API), the imprint and the privacy policy.
  • A start page, which is not necessarily the same as the top level README.md
  • The documents and the API documentation mentioned above, but maybe not from the main branch, but from another one.

And we need a concept that allows updating all these items separately, without "polluting" a development branch with documentation changes. The target would be to have zero changes on a development branch, even if it provides all or some of the documents on the website.

The [odo website](https://straightway.codeberg.page/odo) is fed from different sources: * The top level [README.md](https://codeberg.org/straightway/odo/src/branch/main/README.md) file * The documents in the sub folders (recursively) * [Design](https://codeberg.org/straightway/odo/src/branch/main/Design) * [Documents](https://codeberg.org/straightway/odo/src/branch/main/Documents) * The [API documentation](https://straightway.codeberg.page/odo/api) All these resources are related to a specific branch. They are "compiled" using the `_build` script in the [jekyll folder](https://codeberg.org/straightway/odo/src/branch/main/jekyll/) on a the branch, which in turn generates html files in the [pages repository](https://codeberg.org/straightway/pages) (which contains the web site). However, from the perspective of the development process, I may want to have different sources for this information: * A general frame containing the project name, links to the most important resources (repository, issues, API), the imprint and the privacy policy. * A start page, which is not necessarily the same as the top level README.md * The documents and the API documentation mentioned above, but maybe not from the main branch, but from another one. And we need a concept that allows updating all these items separately, without "polluting" a development branch with documentation changes. The target would be to have zero changes on a development branch, even if it provides all or some of the documents on the website.
kai.boesefeldt added this to the Approved milestone 4 months ago
kai.boesefeldt added the
Documentation
label 4 months ago
mat was assigned by kai.boesefeldt 4 months ago
Sign in to join this conversation.
Loading…
There is no content yet.