feat(docs): add website static page building

!10 nofusscomputing/projects/gitlab-ci!25
This commit is contained in:
2023-05-22 16:39:19 +09:30
parent 88689c87ac
commit 6409627dae
8 changed files with 80 additions and 0 deletions

View File

@ -7,6 +7,7 @@ include:
file: file:
- .gitlab-ci_common.yaml - .gitlab-ci_common.yaml
- template/docker-image.gitlab-ci.yaml - template/docker-image.gitlab-ci.yaml
- template/website.gitlab-ci.yaml
variables: variables:

4
.gitmodules vendored
View File

@ -2,3 +2,7 @@
path = gitlab-ci path = gitlab-ci
url = https://gitlab.com/nofusscomputing/projects/gitlab-ci.git url = https://gitlab.com/nofusscomputing/projects/gitlab-ci.git
branch = development branch = development
[submodule "website-template"]
path = website-template
url = https://gitlab.com/nofusscomputing/infrastructure/website-template.git
branch = development

57
mkdocs.yml Normal file
View File

@ -0,0 +1,57 @@
INHERIT: website-template/mkdocs.yml
repo_name: Gitlab-CI
repo_url: https://gitlab.com/nofusscomputing/projects/docker-mail
edit_uri: '/-/ide/project/nofusscomputing/projects/docker-mail/edit/development/-/pages/'
nav:
- Home: index.md
- Articles:
- articles/index.md
- Projects:
- projects/index.md
- Gitlab CI:
- Build:
- projects/gitlab-ci/mkdocs-build.md
- Linting:
- projects/gitlab-ci/markdown_lint.md
- projects/gitlab-ci/yaml_lint.md
- Templates:
- projects/gitlab-ci/templates/index.md
- projects/gitlab-ci/templates/ansible_roles.md
- projects/gitlab-ci/templates/docker_container.md
- projects/gitlab-ci/templates/website.md
- Validation:
- projects/gitlab-ci/conventional_commits.md
- projects/gitlab-ci/index.md
- projects/gitlab-ci/git_mirror.md
- projects/gitlab-ci/gitlab_release.md
- projects/gitlab-ci/python.md
- Operations:
- operations/index.md
- Contact Us: contact.md

View File

@ -1,6 +1,9 @@
--- ---
title: Amavis DKIM Signing configuration title: Amavis DKIM Signing configuration
Description: How to configure DKIM for No Fuss Computings mail server. Description: How to configure DKIM for No Fuss Computings mail server.
date: 2022-02-16
template: project.html
about: https://gitlab.com/nofusscomputing/projects/docker-mail
--- ---
To utilise DKIM message signing for outbound mail (leaving the server), you will need to configure dkim to use your certificates. To utilise DKIM message signing for outbound mail (leaving the server), you will need to configure dkim to use your certificates.
@ -19,6 +22,7 @@ $ amavisd-new genrsa /certs/amavis/dkim/example.org.dkim.pem 2048 # (1)!
$ chmod g+r /certs/amavis/dkim/example.org.dkim.pem # (2)! $ chmod g+r /certs/amavis/dkim/example.org.dkim.pem # (2)!
$ chgrp amavis /certs/amavis/dkim/example.org.dkim.pem # (2)! $ chgrp amavis /certs/amavis/dkim/example.org.dkim.pem # (2)!
``` ```
1. create your DKIM Key 1. create your DKIM Key
@ -51,6 +55,7 @@ To configure amavis, you will be required to create a confiuguration file with y
``` conf title="/etc/amavis/conf.d/99-dkim-keys" ``` conf title="/etc/amavis/conf.d/99-dkim-keys"
dkim_key( dkim_key(
'example.org', # (1)! 'example.org', # (1)!
'dkim', # (2)! 'dkim', # (2)!

View File

@ -0,0 +1,7 @@
---
title: No Fuss Computings Dockr Mail Server
description: How to use No Fuss Computings Dcokerized E-Mail Server
date: 2023-05-22
template: project.html
about: https://gitlab.com/nofusscomputing/projects/docker-mail
---

View File

@ -1,6 +1,9 @@
--- ---
title: SPF configuration title: SPF configuration
Description: How to configure SPF for No Fuss Computings docker mail server. Description: How to configure SPF for No Fuss Computings docker mail server.
date: 2022-02-17
template: project.html
about: https://gitlab.com/nofusscomputing/projects/docker-mail
--- ---
Sender Policy Framework (SPF) is defined in [RFC7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email](https://datatracker.ietf.org/doc/html/rfc7208). Sender Policy Framework (SPF) is defined in [RFC7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email](https://datatracker.ietf.org/doc/html/rfc7208).
@ -8,8 +11,10 @@ Sender Policy Framework (SPF) is defined in [RFC7208, Sender Policy Framework (S
DNS SPF text record example: DNS SPF text record example:
``` text ``` text
IN TXT "v=spf1 mx a ip4:192.168.0.100 ip6:2001:ef3:2911::/64" IN TXT "v=spf1 mx a ip4:192.168.0.100 ip6:2001:ef3:2911::/64"
" a:mail.example.org a:mail2.example.org -all" " a:mail.example.org a:mail2.example.org -all"
``` ```
1. `v=spf1` Version attribute. only v1 available. 1. `v=spf1` Version attribute. only v1 available.

0
pages/projects/index.md Normal file
View File

1
website-template Submodule

Submodule website-template added at cb55c6bdca