mirror of
https://mau.dev/andreijiroh-dev/website.git
synced 2024-11-10 03:39:38 +00:00
docs(global): update dev docs and add some badges
Signed-off-by: Andrei Jiroh Halili <ajhalili2006@andreijiroh.eu.org>
This commit is contained in:
parent
a147fc6264
commit
c2acf592c5
2 changed files with 35 additions and 33 deletions
54
README.md
54
README.md
|
@ -15,42 +15,45 @@ built with Mkdocs + [Material theme](https://go.andreijiroh.eu.org/mkdocs-materi
|
|||
Canonically developed at [mau.dev](https://mau.dev/andreijiroh.dev/website.git) where the deployments happen, with the following mirrors being maintained:
|
||||
|
||||
* GitHub: <https://github.com/ajhalili2006/ajhalili2006.github.io.git>, where Docker image builds happen
|
||||
* Jetbrains Space (personal): <https://ajhalili2006.jetbrains.space/p/web/repositories/andreijiroh.dev/files/README.md>
|
||||
* Sourcehut: <https://git.sr.ht/~ajhalili2006/tildeweb>
|
||||
* Jetbrains Space (personal): <https://ajhalili2006.jetbrains.space/p/web/repositories/andreijiroh.dev> (repository clone URL: `git.jetbrains.space/ajhalili2006/web/andreijiroh.dev.git`)
|
||||
* Sourcehut: <https://git.sr.ht/~ajhalili2006/web>
|
||||
|
||||
## Development
|
||||
## Site Development
|
||||
|
||||
Use the clone links from either the canonical repository URL or its mirrors
|
||||
[as mentioned above](#mirrors) or open this repo in a cloud development
|
||||
environment using these links:
|
||||
|
||||
[![Open in Gitpod](https://img.shields.io/badge/open%20in-Gitpod-orange?style=flat-square&logo=gitpod)](https://gitpod.io/#https://mau.dev/andreijiroh.dev/website)
|
||||
[![Open in Codespaces](https://img.shields.io/badge/open%20in-Codespaces-black?style=flat-square&logo=github)](https://codespaces.dev/ajhalili2006/ajhalili2006.github.io)
|
||||
|
||||
### Building from source
|
||||
|
||||
```bash
|
||||
# clone the repo
|
||||
# pick one on the clone URLs
|
||||
glab repo clone https://mau.dev/ajhalili2006/tildeverse-web
|
||||
gh repo clone ajhalili2006/ajhalili2006.github.com
|
||||
git clone git@git.sr.ht:~ajhalili2006/tildeweb
|
||||
|
||||
# maybe do this on a feature branch
|
||||
git switch -c your-git-username/your-suggestion-here
|
||||
|
||||
# install deps via venv
|
||||
python3 -m venv venv
|
||||
source ./venv/bin/activate
|
||||
pip3 install -r requirements.txt
|
||||
# install deps via pipenv...
|
||||
pipenv install
|
||||
# ...or via pip3 with --user flag (generated from "pipenv requirements" and sending its output
|
||||
# to requirements.txt)
|
||||
pip install -r requirements.txt --user
|
||||
|
||||
# preview site and edit in another session
|
||||
mkdocs serve
|
||||
nano markdown/path-to-file.md
|
||||
mkdocs serve --watch overrides --watch-theme --livereload
|
||||
```
|
||||
|
||||
# done?
|
||||
git stage . && git commit --signoff
|
||||
### Sending patches
|
||||
|
||||
|
||||
```bash
|
||||
# send patches via GitLab or GitHub through the CLI
|
||||
glab auth login --host "https://mau.dev" # authenticate CLI
|
||||
glab -R https://mau.dev/ajhalili2006/tildeverse-web mr create --allow-collaboration -b main
|
||||
gh auth login # authenticate CLI, GitHub.com edition
|
||||
glab -R https://mau.dev/andreijiroh.dev/website mr create --allow-collaboration -b main
|
||||
gh -R ajhalili2006/tildeverse-web pr create # might automatically closes PR due to mirror status
|
||||
|
||||
# or via my public inbox on sourcehut
|
||||
# see https://git-send-email.io for setup and guide
|
||||
git config sendemail.to "~ajhalili2006/public-inbox@lists.sr.ht" # NOT my personal email
|
||||
git config format.subjectPrefix "PATCH tildeweb" # identification in archives + builds.sr.ht
|
||||
git config format.subjectPrefix "PATCH web" # identification in archives + builds.sr.ht
|
||||
git config --global sendemail.annotate yes
|
||||
git config --global format.signOff true # needed for compliance with Linux DCO
|
||||
git send-email HEAD^
|
||||
|
@ -65,7 +68,8 @@ the patches for any reasons, including mental health breaks.
|
|||
|
||||
## License
|
||||
|
||||
Unless otherwise noted, source code is licensed under the MPl-2.0 while website content (text-only)
|
||||
is under CC BY-SA 4.0
|
||||
Unless otherwise noted, source code is licensed under the MPL-2.0 while website content (text-only)
|
||||
is under CC BY-SA 4.0.
|
||||
|
||||
The only thing that's not covered by this is [the favicon version](markdown/assets/images/favicon.png) of my profile picture.
|
||||
The only thing that's not covered by this is [the favicon version](markdown/assets/images/favicon.png)
|
||||
of my (current) profile picture.
|
||||
|
|
|
@ -1,11 +1,9 @@
|
|||
# CI image for GitLab CI deploys
|
||||
# Custom `mkdocs-material` CI image
|
||||
|
||||
This directory contains the necessary files to build a container image for the website deployments.
|
||||
Builds on Alpine edge, mostly used by @ajhalili2006 to deploy
|
||||
builds over GitLab Ci.
|
||||
|
||||
## How to build
|
||||
## Build from source
|
||||
|
||||
Just run the script to build locally
|
||||
|
||||
```bash
|
||||
./docker/build.sh
|
||||
```
|
||||
After cloning [Andrei Jiroh's website sources](https://mau.dev/andreijiroh.dev/website), you can run the `build.sh` script
|
||||
(see script source for available options)
|
||||
|
|
Loading…
Reference in a new issue