From 80a2711f4523de18f9ff99918ae55c1df43c8e1a Mon Sep 17 00:00:00 2001 From: Jonas Zohren Date: Fri, 23 Jul 2021 13:37:02 +0200 Subject: [PATCH] Move some documentation to docs/ and start overhaul --- .gitlab-ci.yml | 24 +++++++++--------------- mkdocs.yml | 20 ++++++++++++++++++++ 2 files changed, 29 insertions(+), 15 deletions(-) create mode 100644 mkdocs.yml diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 8a0226bf..31941941 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -370,23 +370,17 @@ publish:package: - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file conduit-x86_64-unknown-linux-gnu.deb "${BASE_URL}/conduit-x86_64-unknown-linux-gnu.deb"' - pages: - stage: publish - image: rust - variables: - CARGO_HOME: $CI_PROJECT_DIR/cargo - before_script: - - export PATH="$PATH:$CARGO_HOME/bin" - - mdbook --version || cargo install mdbook - script: - - mdbook build -d public + stage: "publish" + image: + name: "squidfunk/mkdocs-material" + entrypoint: [""] + tags: ["docker"] + needs: [] rules: - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH' + script: + - "mkdocs build --site-dir public" artifacts: paths: - - public - cache: - key: mdbook_cache - paths: - - $CARGO_HOME/bin + - "public" diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..dac38644 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,20 @@ +site_name: Conduit Docs +site_description: Conduit is a simple, fast and reliable chat server for the Matrix protocol +theme: + name: material +repo_url: https://gitlab.com/famedly/conduit +nav: + - Home: index.md + - Installation: + - Prerequisites: installation/prerequisites.md + - Distribution Packages: installation/packages.md + - Manual: installation/manual.md + - Docker: installation/docker.md + - Configuration: + - Conduit.toml: configuration/conduit.toml.md + - Appservices: configuration/appservices.md + - Development: + - Basics: development/basics.md + - Cross compilation: development/cross-compilation.md + - Tests & CI: development/tests-ci.md +