Skip to content

Commit

Permalink
docs: more tweaking of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jippi committed Jun 28, 2024
1 parent 4f0161e commit 958ef90
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 10 deletions.
8 changes: 4 additions & 4 deletions .env.docker
Original file line number Diff line number Diff line change
Expand Up @@ -870,7 +870,7 @@ SESSION_DRIVER="redis"

# A random 32-character string to be used as an encryption key.
#
# !!! tip This will be auto-generated by Docker during bootstrap
# !!! tip "This will be auto-generated by Docker during bootstrap"
#
# This key is used by the Illuminate encrypter service and should be set to a random,
# 32 character string, otherwise these encrypted strings will not be safe.
Expand Down Expand Up @@ -931,15 +931,16 @@ TZ="${APP_TIMEZONE}"
# The docker tag prefix to use for pulling images, can be one of
#
# * latest
# * <some semver release>
# * [some semver release]
# * staging
# * edge
# * branch-<some branch name>
# * pr-<some merge request id>
# * pr-[some merge request id]
#
# Combined with [DOCKER_APP_RUNTIME] and [PHP_VERSION] configured
# elsewhere in this file, the final Docker tag is computed.
#
# @see https://jippi.github.io/docker-pixelfed/customize/tags/
# @dottie/validate required
DOCKER_APP_RELEASE="v0.12"

Expand All @@ -950,7 +951,6 @@ DOCKER_APP_RELEASE="v0.12"
# Example:
#
# * 8.3
# * latest
#
# Do *NOT* use the full Docker tag (e.g. "8.3.2RC1-fpm-bullseye")
# *only* the version part. The rest of the full tag is derived from
Expand Down
26 changes: 24 additions & 2 deletions docs-customization/template/dot-env.template.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,31 @@

# .env settings

{{ range .Groups -}}{{- $group := . -}}## {{ .String }}
!!! info

{{ range .Assignments -}}{{- $assignment := . -}}### {{ .Name }} {{ " " }} { data-toc-label="{{ .Name }}" }
This is an autogenerated page containing all the settings from the default `.env.docker` file. Below is a quick overview of the most frequently changed sections

**Pixelfed settings**

* [App](#app)
* [Database](#database)
* [Mail](#mail)
* [Redis](#redis)
* [Storage](#storage)

**Docker settings**

* [Shared](#docker-shared)
* [App](#docker-app)
* [Database](#docker-db)
* [Proxy](#docker-proxy)
* [Redis](#docker-redis)
* [Web](#docker-web)
* [Worker](#docker-worker)

{{ range .Groups -}}{{- $group := . -}}## {{ .String | title }}

{{ range .Assignments -}}{{- $assignment := . -}}### {{ .Name | title }} {{ " " }} { data-toc-label="{{ .Name }}" }

{{ if .Annotation "dottie/validate" | first | default "" | contains "required" }}<!-- md:flag required -->{{ end }}
{{ if eq .Literal "" }}<!-- md:default none -->
Expand Down
2 changes: 1 addition & 1 deletion docs/customize/build-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Any valid Docker Hub PHP version is acceptable here, as long as it's [published
* `8.2.14` will use PHP 8.2.14
* `latest` will use whatever is the latest PHP version

**Default value**: `8.1`
**Default value**: `8.3`

## `PHP_PECL_EXTENSIONS`

Expand Down
6 changes: 3 additions & 3 deletions docs/migrate/v3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This document assume you are running [Docker Compose v2](v2.0.md) already and is

!!! danger "These changes are breaking, removing, or changing existing behavior from Docker Compose v1 and *requires* your attention and possibly some steps to fix."

### <!-- md:flag breaking-change --> New Docker image names { data-toc-label="New Docker image names" }
### <!-- md:flag breaking-change --> New Docker image names { data-toc-label="New docker image names" }

Since `docker-pixelfed` do not exist within the `pixelfed` project itself, the URL for the container images will change.

Expand Down Expand Up @@ -64,13 +64,13 @@ v3 splits the Dockerfile into two to keep them focused, and reducing build times

This should not directly impact most users, as any custom build you did before (custom PHP extensions, frontend, etc.) can still be done against the [`runtime`](../customize/runtimes.md) Docker image.

### <!-- md:flag breaking-change --> No `latest` tags { data-toc-label="No 'latest' tags" }
### No `latest` tags { data-toc-label="No 'latest' tags" }

`latest` tags are typically pretty dangerous to use, especially in a fast-moving project such as Pixelfed where things might break in patch releases.

[See the dedicated `tags` documentation for more information](../customize/tags.md)

### <!-- md:flag breaking-change --> No `fpm` runtime { data-toc-label="No 'fpm' runtime" }
### No `fpm` runtime { data-toc-label="No `FPM runtime`" }

v3 only builds `apache` (with `mod_php`) and `nginx` (with `fpm`) runtimes now.

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ markdown_extensions:
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
auto_append:
- docs-customization/includes/abbreviations.md
- pymdownx.superfences:
Expand Down

0 comments on commit 958ef90

Please sign in to comment.