Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting issues with website and documentation repos #64

Open
1 of 4 tasks
fzipi opened this issue Apr 27, 2024 · 0 comments
Open
1 of 4 tasks

Documenting issues with website and documentation repos #64

fzipi opened this issue Apr 27, 2024 · 0 comments

Comments

@fzipi
Copy link
Member

fzipi commented Apr 27, 2024

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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant