Skip to content
Snippets Groups Projects
  1. Jun 12, 2022
    • Sheogorath's avatar
      docs: Add external links workaround · 26724ae2
      Sheogorath authored
      This patch adds some external links to the docs navigation section.
      Since mdbooks doesn't support this by default, this adds a JS file as
      workaround, which avoids forking the theme or writing an extension for
      mdbooks.
      
      References:
      https://github.com/rust-lang/mdBook/issues/1354
      Verified
      26724ae2
    • Sheogorath's avatar
      docs: Adjust repository link icon · 5333c505
      Sheogorath authored
      This patch changes the repository icon to GitLab as the repository isn't
      set up on GitHub, the icon would be completely misleading.
      Verified
      5333c505
    • Sheogorath's avatar
      docs: Add default redirect · cbaee366
      Sheogorath authored
      Verified
      cbaee366
    • Sheogorath's avatar
      docs(mdbook): Add title and gitlab links · 00495f8a
      Sheogorath authored
      This patch adds a title to the documentation as well as some links to
      the repository as well as the WebIDE for GitLab adjustments.
      Verified
      00495f8a
    • Sheogorath's avatar
      docs: Initial documentation set up · bfdafa63
      Sheogorath authored
      This patch adds the initial structure for the documentation of the
      Shivering-Isles GitOps Infrastructure repository. It uses mdbook to
      create an easy to read documentation.
      
      It uses mdbook, because it's an easy single-binary tool to generate
      documentation. This fits the tooling schema of koolbox quite well and
      can be easily integrated into the automatic updates toolchain already
      used. Further it uses markdown, which allows easy writing of further
      documentation and re-use of existing documentation.
      
      The documentation structure re-uses various existing READMEs from
      components. These might be replaced in the long run.
      
      It also lays out future plans for documentation, which is currently
      still on the TODO list. This should help to keep the overall structure
      in mind and provide the general direction.
      
      References:
      https://rust-lang.github.io/mdBook/index.html
      Verified
      bfdafa63
Loading