dallasgroot/Documentation
1
0
Fork 0
mirror of https://codeberg.org/Codeberg/Documentation.git synced 2026-06-16 05:13:54 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions
631 commits 6 branches 0 tags 19 MiB
Commit graph

24 commits

Author SHA1 Message Date
Javier Pérez
9a4e3cdc27 Fix the Dockerfile (#630) 
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Added

- Ignore the `.pnpm-store` directory generated by the `pnpm` package manager.
- Make the `eleventy` command render changes incrementally when in dev ("serve") mode.

## Changed

- Rename the npm script `serve` to `dev` to improve clarity.
- Update documentation to reflect new npm script name and Dockerfile volume mount point.

## Fixed

- Update the `Dockerfile` to fix errors when building the documentation container.

---

## 1st problem

The current version of the `README.md` tells to run this command:

`docker build -t Codeberg/Documentation-server .`

Unfortunately, it returns this error:

```bash
docker build -t Codeberg/Documentation-server .
[+] Building 0.0s (0/0) docker:default
ERROR: invalid tag "Codeberg/Documentation-server": repository name must be lowercase
```

## 2nd problem

If you try to build an image with the current version of `Dockerfile`, this error occurs:

```bash
[+] Building 2.7s (5/10)                                docker:default
 => [internal] load build definition from Dockerfile              0.0s
 => => transferring dockerfile: 409B                              0.0s
 => [internal] load metadata for docker.io/library/node:16.15.1-  1.1s
 => [internal] load .dockerignore                                 0.0s
 => => transferring context: 2B                                   0.0s
 => CACHED [1/7] FROM docker.io/library/node:16.15.1-stretch-sli  0.0s
 => ERROR [2/7] RUN apt-get update && apt-get -y upgrade          1.4s
------
 > [2/7] RUN apt-get update && apt-get -y upgrade:
0.235 Ign:1 http://security.debian.org/debian-security stretch/updates InRelease
0.278 Ign:2 http://security.debian.org/debian-security stretch/updates Release
0.280 Ign:3 http://deb.debian.org/debian stretch InRelease
0.293 Ign:4 http://security.debian.org/debian-security stretch/updates/main all Packages
0.308 Ign:5 http://security.debian.org/debian-security stretch/updates/main amd64 Packages
0.320 Ign:6 http://deb.debian.org/debian stretch-updates InRelease
0.323 Ign:4 http://security.debian.org/debian-security stretch/updates/main all Packages
0.339 Ign:5 http://security.debian.org/debian-security stretch/updates/main amd64 Packages
0.356 Ign:4 http://security.debian.org/debian-security stretch/updates/main all Packages
0.363 Ign:7 http://deb.debian.org/debian stretch Release
0.378 Ign:5 http://security.debian.org/debian-security stretch/updates/main amd64 Packages
0.408 Ign:4 http://security.debian.org/debian-security stretch/updates/main all Packages
0.415 Ign:8 http://deb.debian.org/debian stretch-updates Release
0.441 Ign:5 http://security.debian.org/debian-security stretch/updates/main amd64 Packages
0.463 Ign:9 http://deb.debian.org/debian stretch/main amd64 Packages
0.465 Ign:4 http://security.debian.org/debian-security stretch/updates/main all Packages
0.482 Ign:5 http://security.debian.org/debian-security stretch/updates/main amd64 Packages
0.496 Ign:4 http://security.debian.org/debian-security stretch/updates/main all Packages
0.503 Ign:10 http://deb.debian.org/debian stretch/main all Packages
0.511 Err:5 http://security.debian.org/debian-security stretch/updates/main amd64 Packages
0.511   404  Not Found [IP: 151.101.2.132 80]
0.542 Ign:11 http://deb.debian.org/debian stretch-updates/main all Packages
0.583 Ign:12 http://deb.debian.org/debian stretch-updates/main amd64 Packages
0.623 Ign:9 http://deb.debian.org/debian stretch/main amd64 Packages
0.662 Ign:10 http://deb.debian.org/debian stretch/main all Packages
0.701 Ign:11 http://deb.debian.org/debian stretch-updates/main all Packages
0.741 Ign:12 http://deb.debian.org/debian stretch-updates/main amd64 Packages
0.781 Ign:9 http://deb.debian.org/debian stretch/main amd64 Packages
0.825 Ign:10 http://deb.debian.org/debian stretch/main all Packages
0.872 Ign:11 http://deb.debian.org/debian stretch-updates/main all Packages
0.912 Ign:12 http://deb.debian.org/debian stretch-updates/main amd64 Packages
0.953 Ign:9 http://deb.debian.org/debian stretch/main amd64 Packages
0.994 Ign:10 http://deb.debian.org/debian stretch/main all Packages
1.033 Ign:11 http://deb.debian.org/debian stretch-updates/main all Packages
1.073 Ign:12 http://deb.debian.org/debian stretch-updates/main amd64 Packages
1.112 Ign:9 http://deb.debian.org/debian stretch/main amd64 Packages
1.152 Ign:10 http://deb.debian.org/debian stretch/main all Packages
1.193 Ign:11 http://deb.debian.org/debian stretch-updates/main all Packages
1.233 Ign:12 http://deb.debian.org/debian stretch-updates/main amd64 Packages
1.274 Err:9 http://deb.debian.org/debian stretch/main amd64 Packages
1.274   404  Not Found
1.316 Ign:10 http://deb.debian.org/debian stretch/main all Packages
1.357 Ign:11 http://deb.debian.org/debian stretch-updates/main all Packages
1.397 Err:12 http://deb.debian.org/debian stretch-updates/main amd64 Packages
1.397   404  Not Found
1.401 Reading package lists...
1.407 W: The repository 'http://security.debian.org/debian-security stretch/updates Release' does not have a Release file.
1.407 W: The repository 'http://deb.debian.org/debian stretch Release' does not have a Release file.
1.407 W: The repository 'http://deb.debian.org/debian stretch-updates Release' does not have a Release file.
1.407 E: Failed to fetch http://security.debian.org/debian-security/dists/stretch/updates/main/binary-amd64/Packages  404  Not Found [IP: 151.101.2.132 80]
1.407 E: Failed to fetch http://deb.debian.org/debian/dists/stretch/main/binary-amd64/Packages  404  Not Found
1.407 E: Failed to fetch http://deb.debian.org/debian/dists/stretch-updates/main/binary-amd64/Packages  404  Not Found
1.407 E: Some index files failed to download. They have been ignored, or old ones used instead.
------
Dockerfile:3
--------------------
   1 |     FROM node:16.15.1-stretch-slim
   2 |
   3 | >>> RUN apt-get update && apt-get -y upgrade
   4 |
   5 |     RUN apt-get install -y git curl
--------------------
ERROR: failed to solve: process "/bin/sh -c apt-get update && apt-get -y upgrade" did not complete successfully: exit code: 100
```

I have fixed both issues and tested building the image and running the container to build the docs site locally.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/630
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
 2025-11-21 21:40:44 +01:00
Arno Welzel
1047a82256 Update documentation (README, Forgejo Actions) (#667) 
- Updated README.md to explain how to do linting and use prettier.
- Updated "Using Forgejo Actions (Self-hosted)" by pointing to the the official Forgejo documentation to avoid duplicating content.

Co-authored-by: Gusted <gusted@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/667
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Arno Welzel <privat@arnowelzel.de>
Co-committed-by: Arno Welzel <privat@arnowelzel.de>
 2025-10-20 19:04:43 +02:00
Javier Pérez
c6ac9a9f94 Reduce line length limit and format content (#623) 
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Changed

- Update line length limit from 500 characters to 120 characters.

## Fixed

- Most instances of these lint issues:
  1. Lines longer than 120 characters ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)).
  2. Trailing whitespaces ([MD009](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md)).
  3. Ordered list item prefix ([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md)).
  4. Bare links ([MD034](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md)).

Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/623
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
 2025-06-14 11:38:21 +02:00
crapStone
cfb83ba171 chore: fix preview plugin link (#586) 
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/586
 2025-04-24 20:31:46 +00:00
Gusted
2fa6aaedbb chore: update deployment instructions (#491) 
`deploy.sh` is not used.

Link to the cron job.

Resolves #438

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/491
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
 2024-11-28 03:43:55 +00:00
pat-s
74e8925bec add spellchecker (#439) 
fix #148

Adds a spell checker via `cspell` and fixes some spelling issues in the docs.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/439
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-committed-by: pat-s <patrick.schratz@gmail.com>
 2024-06-12 10:20:37 +00:00
Patrick Schratz
65e44a8cfa Add deploy preview via surge (#434) 
fix #345

- [x] Use a dummy user instead of my personal one (to avoid getting notifications from surge)

- [x] README doc

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/434
 2024-06-12 08:52:08 +00:00
pat-s
c12e26e446 Switch to pnpm (#432) 
As `pnpm` is xx times faster than `npm`.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/432
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-committed-by: pat-s <patrick.schratz@gmail.com>
 2024-06-12 08:44:42 +00:00
crapStone
da1b77aa6a Add woodpecker ci & many linters (and their required fixes) (#377) 
closes #238

Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/377
Co-authored-by: crapStone <crapstone01@gmail.com>
Co-committed-by: crapStone <crapstone01@gmail.com>
 2024-06-11 07:51:22 +00:00
oatbiscuits
55a504e33a Add search functionality (#370) 
This should solve #23.

This is a fully static search implementation powered by [Pagefind](https://pagefind.app/).

In terms of UI, I found and implemented a section in the sidebar for searching the documentation. It was hidden presumably waiting for implementation. It mentioned using the slash (/) key for searching, so I implemented the hotkey as well.

I made the indexing command required by Pagefind run after Eleventy finishes building using the `.after` hook.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/370
Co-authored-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
Co-committed-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
 2023-11-30 21:33:22 +00:00
René Wagner
d182737311 add contributors reference to README 
closes #275
 2023-02-14 16:52:04 +00:00
René W
b276cfcca9 Update 'README.md' 2022-07-21 16:47:59 +02:00
Jan Klippel
2e087e8c0c
Fix: typo in docker run command 2022-05-21 12:34:47 +02:00
Jan Klippel
5bdac45ee5 Create a new section documentation 
Extract important articles from the now lengthy FAQ.
This helps to find the documented basics.
Move the Docs-Contributor-FAQ to the new documentation section.
 2022-04-14 12:34:58 +02:00
Jan Klippel
29cae330d0 Add Dockerfile to serve documentation 
Use a container to preview the documentation for those of us who cannot or do not want to install npm/nodejs on their machines.

- Add a Dockefile to create a docker image containing nodejs and the software needed to serve the documentation
- Extend README.md with the option to use the Dockerfile to preview the documentation
 2022-04-14 12:34:21 +02:00
Lucas Hinderberger
7668e109a7 Contributor FAQ 2020-10-05 00:42:23 +02:00
Lucas Hinderberger
541ad779bb Integrating deploy script into npm workflow 2020-08-25 11:54:12 +02:00
Lucas Hinderberger
cfa9cbbbf5 Blending together codeberg-docs-prototype and original Codeberg/Documentation 2020-08-13 12:31:45 +02:00
codeberg.org
ec1ef2713f Organize docs 2020-08-02 17:13:08 +02:00
n
241300bd54 Move documentation from Wiki to main repo 2020-06-27 13:07:05 +09:00
buhtz
aaccae3333 Pointing directly to the Overview landing page of the wiki 2020-05-27 14:21:49 +02:00
hw
ee7c064b24 reference to documentation wiki, the README text is already part thereof 2019-12-12 15:33:56 +01:00
buhtz
701da37d30 Clone & Commit via HTTP 
Simple example about how to clone and commit/push via HTTP with Username and Password.
 2019-06-04 23:44:55 +02:00
Christian Buhtz
8b2fb8ebde empty README.md 2019-06-04 23:36:23 +02:00