Skip to content

Documenting issues with website and documentation repos #64

@fzipi

Description

@fzipi

Right now there are some problems or annoyances that we cannot solve with the current setup of documentation and website in different repos.

Let me add this list here for reference, maybe in the future we can solve this:

  • cross linking between them must use external urls, otherwise references won't be found.
  • we cannot mount documentation "inside" the website (using hugo mounts), because it will use only one theme, and we have a separated theme for the docs.
  • we cannot use aliases in the documentation (e.g. /installation was used a lot in blog posts) to use both urls properly.
  • updating the documentation triggers a deployment of the website, but the changes from the documentation will not be picked up due to the submodule reference. A separate PR to the website is currently necessary (should be fixed by Automatically update docs submodule #115)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions