diff --git a/docs/gitnet_page/overview.md b/docs/gitnet_page/overview.md new file mode 100644 index 0000000..eabc449 --- /dev/null +++ b/docs/gitnet_page/overview.md @@ -0,0 +1,9 @@ +# Introduction + +**[Gitnet] est la forge logicielle que je gère depuis quelques années et qui héberge la totalité de mes projets**. Elle s'appuie sur l'excellentissime **[Gitea], un logiciel libre pour faire son propre Github/Gitlab** sans dépenser des fortunes en ressources matérielles. + +[gitea] est un logiciel très complet mais une des fonctionnalités qui peut manquer à certain⋅e⋅s est **la publication de pages web statiques** via la forge. [codeberg](https://codeberg.org/) a développé [codeberg/pages-server], un projet écrit en go qui permet de réaliser cette fonctionnalité. il lance un serveur web et sert les fichiers qui sont récupérés via l'api. après l'avoir forké pour le personnalisé, il est à présent déployé sur [gitnet pages](https://gitnet.page). + +[Gitnet]: https://gitnet.fr +[Gitea]: https://gitea.io/ +[Codeberg/pages-server]: https://codeberg.org/Codeberg/pages-server diff --git a/docs/gitnet_page/usage.md b/docs/gitnet_page/usage.md new file mode 100644 index 0000000..3af1416 --- /dev/null +++ b/docs/gitnet_page/usage.md @@ -0,0 +1,21 @@ +# Utilisation + +Pour commencer à publier, vous devez créer un dépot `pages` dans lequel vous y déposerez vos fichiers. Le contenu sera accessible via `https://votre-login.gitnet.page/{fichier}`. + +Dans le cas où vous souhaitez intégrer des pages à un dépot existant, ajoutez une branche `pages` puis accédez à votre contenu via `https://votre-login.gitnet.page/le-depot/{fichier}` : + +```bash +git switch --orphan pages +# Si vous avez des fichiers ignorés par git qui existent : +git rm --cached -r . +``` + +Et si vous désirez accéder à du contenu qui se trouve sur une autre branche, il faudra la spécifier de cette façon : `https://votre-login.gitnet.page/le-depot/@la-branche/{fichier}`. + +Vous pouvez utiliser un générateur de site static mais il faudra ajouter un CI/CD. J'ai réalisé des tests avec [Hugo](https://gohugo.io/) + [Woordpecker](https://woodpecker-ci.org/) et ça marche bien ! On build la branche ou se trouve les sources, on copie le résultat dans la branche `pages` et on pousse le code sur [Gitnet]. Voici la [configuration utilisée](https://gitnet.fr/deblan/pages-ci/src/branch/master/.woodpecker.yml). + +Si toutefois le service venait à être pas mal utilisé, alors j'intégrerai des fonctionnalités plus avancées comme le nom de domaine personnalité. Tel qu'il est déployé actuellement, ce n'est pas possible. + +[Gitnet]: https://gitnet.fr +[Gitea]: https://gitea.io/ +[Codeberg/pages-server]: https://codeberg.org/Codeberg/pages-server diff --git a/docs/status.yml b/docs/services/status.yml similarity index 100% rename from docs/status.yml rename to docs/services/status.yml diff --git a/mkdocs.yml b/mkdocs.yml index 72372d1..f527c75 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,6 +14,7 @@ theme: favicon: /_static/img/logo.svg features: - content.code.copy + - navigation.tabs palette: - scheme: default toggle: @@ -42,12 +43,16 @@ markdown_extensions: nav: - Accueil: index.md - - "Service d'hébergement": - - "Deblan Hosting": hosting/overview.md - - "Services": hosting/services.md - - "Accès": hosting/access.md - - "Conditions générales d'utilisation": hosting/cgu.md + - "Hébergement": + - "Deblan Hosting": + - "Introduction": hosting/overview.md + - "Services": hosting/services.md + - "Accès": hosting/access.md + - "Conditions générales d'utilisation": hosting/cgu.md + - "Gitnet page": + - "Introduction": gitnet_page/overview.md + - "Utilisation": gitnet_page/usage.md - "Services": - "Accès libre": services/public.md - "Sur inscription": services/private.md - - "États des services": status.md + - "États des services": services/status.md