0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-23 22:20:43 -05:00
Commit graph

281 commits

Author SHA1 Message Date
Caesar Schinas
a3c639ff49 better description of input validation attributes
Closes https://codeberg.org/forgejo/website/issues/168
2023-08-19 20:03:28 +00:00
Caesar Schinas
c6ab3c37fb
fix: broken links from Gitea docs import
Invalid link templates left over from docs import from Gitea.

Closes https://codeberg.org/forgejo/website/issues/160
2023-08-19 16:26:57 +01:00
Caesar Schinas
ba892adf7f add yaml to editorconfig 2023-08-19 06:27:35 +00:00
Caesar Schinas
db41d2411f
CI: use slashes in backport branch names and labels 2023-08-18 23:44:21 +01:00
Loïc Dachary
db05f79562 CI: do nothing instead of failing if trying to backport a PR 2023-08-18 20:51:01 +00:00
Robin Kloppe
4a3f87ad43
Removed Push Options link from User Index - Bug #30 2023-08-18 22:40:37 +02:00
Robin Kloppe
b8c2ed65c9 Replaced mydomain with example - RFC2606, RFC6761 2023-08-18 22:27:55 +02:00
Earl Warren
7cc799cfa1
README: add backport instructions 2023-08-18 15:09:05 +02:00
Earl Warren
3de0164331
CI: use WEBSITETOKEN
because using GITHUB_TOKEN has the undesirable side effect of blocking
the workflows when creating a branch and a PR from it
2023-08-18 14:50:44 +02:00
Earl Warren
2fd1640125
CI: add backport workflow
Refs: https://codeberg.org/forgejo/docs/issues/18
2023-08-18 14:12:49 +02:00
Loïc Dachary
3d68e4f36e
CI: move the preview script to an action 2023-08-17 23:56:58 +02:00
Loïc Dachary
5dde3a4231 add a comment with a link to the preview on creation
Refs: https://codeberg.org/forgejo/docs/issues/3
2023-08-17 17:30:40 +00:00
Loïc Dachary
67fdb5449b
developer: link to the CI file for go-version recommendation 2023-08-17 19:01:23 +02:00
Caesar Schinas
2d3459594d
document "And Your Own Notifications" setting 2023-08-17 14:11:28 +01:00
Caesar Schinas
4e059dc7f9
add linting for docs markdown content 2023-08-16 23:57:11 +01:00
crystal
8b922f661d
Add "internal" pull request instructions 2023-08-16 10:01:15 -06:00
Earl Warren
de971ac0e2 update the website when a branch is pushed (#9)
TODO:

- [x] comment out the `git push` once the website has submodules merged in

Fixes: https://codeberg.org/forgejo/docs/issues/8

Additionally

* Upgrade to node:20
* Exclude the README.md when copying to the preview

* Allow forgejo-website to push to main on website

![image](/attachments/14f4f38f-fdb8-4ca7-9aee-d9b7e108d71e)

Preview: https://forgejo.codeberg.page/@docs_pull_9/
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/9
Reviewed-by: Loïc Dachary <dachary@noreply.codeberg.org>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2023-08-16 10:32:04 +00:00
Earl Warren
fc108d2064 add CI to preview PRs (#5)
TODO:

- [x] clone from website instead of caesar
- [x] skip the proof of change commit

Preview: https://forgejo.codeberg.page/@docs_pull_5/

This is a simplistic approach to get started with previews. It copies the website, moves the docs under `/forgejo-docs/{{ base branch }}`, create the website and publishes it for preview. No doubt the actual workflow will be different but that needs to be decided.

* Added a WEBSITETOKEN secret created from the forgejo-website user. It is a token with write access to repositories. https://codeberg.org/forgejo/docs/settings/actions/secrets. Contrary to woodpecker it is not in an environment variable but will be replaced when inserting `${{ secrets.WEBSITETOKEN }}` somewhere
* In the environment the variable was replaced CI_COMMIT_PULL_REQUEST → `${{ env.GITHUB_REF_NAME }}`
* The preview is published at https://forgejo.codeberg.page/@docs_pull_N/ instead of https://forgejo.codeberg.page/@pull_N/
* The `$$` were replaced with `$` in the script because Forgejo Actions does not interpret `$` and therefore does not need escaping them to `$$`

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/5
Reviewed-by: Loïc Dachary <dachary@noreply.codeberg.org>
Reviewed-by: Caesar Schinas <caesar@caesarschinas.com>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2023-08-16 09:31:01 +00:00
Caesar Schinas
c14ccdf2d2
add editorconfig 2023-08-16 00:09:09 +01:00
Caesar Schinas
c592e1acb1
add README 2023-08-15 15:53:17 +01:00
Caesar Schinas
27864fec2b
move docs to subfolder 2023-08-15 00:19:15 +01:00
Vlad-Stefan Harbuz
ea5e4573fe
Replace “MAILER_TYPE” with “PROTOCOL” 2023-08-13 17:18:48 +01:00
Caesar Schinas
6ec4fbe7c8
Merge branch 'storage' into next
# Conflicts:
#	admin/config-cheat-sheet.md
2023-08-13 17:16:28 +01:00
Earl Warren
dd92764a36
docs: admin: storage: fix sections names
# Conflicts:
#	v1.21/admin/config-cheat-sheet.md
#	v1.21/admin/storage.md
2023-08-13 17:12:52 +01:00
Earl Warren
41ee7cc748
docs: admin: [attachments] is actually [attachment]
So it actually is [attachment] or [storage.attachments], one singular
and one plural. One more reason to **not** document [storage.XXXX].

# Conflicts:
#	v1.21/admin/config-cheat-sheet.md
#	v1.21/admin/storage.md
2023-08-13 17:12:52 +01:00
Caesar Schinas
fd669862e6
docs: s/attachements/attachments/
# Conflicts:
#	v1.20/admin/config-cheat-sheet.md
#	v1.21/admin/storage.md
2023-08-13 17:12:51 +01:00
Earl Warren
13e1c388d7
docs: admin: config-cheat-sheet: remove references to [storage.xxxx] 2023-08-13 17:12:51 +01:00
Loïc Dachary
69843f60cd
docs: admin: storage: do not document [storage.XXXX]
its behavior is not thoroughly tested and varies in ways that are confusing
2023-08-13 17:12:51 +01:00
Loïc Dachary
c06a49e81c
docs: admin: storage: the defaut root for storage is APP_DATA_PATH 2023-08-13 17:12:51 +01:00
Gusted
087f379291
Add new functionality to moderation docs
- Ref https://codeberg.org/forgejo/forgejo/pulls/1151
2023-08-13 17:12:01 +01:00
Gusted
ace76320ed
Create v1.21 documentation
A verbatim copy of the v1.20 documentation to build upon. With just a
replacement of v1.20 with v1.21 where relevant.
2023-08-13 17:12:01 +01:00
Earl Warren
ab0782c39c
docs: developer: workflow: requirement for Forgejo database migrations
While feature branches may have different requirements for the Forgejo
tables, they are constrained by the migration logic that requires they
happen in sequence and are listed in the same list. If each feature
branch changes the `forgejo_migrations/migrate.go` file independently,
it is bound to conflict with other feature branches trying to do the
same.

To avoid this situation it is proposed that once a migration
developped and tested in a freature branch is final, it is isolated in
a commit and moved to the `forgejo-development` branch. This can
happen during a rebase or with a pull request.

It is probably better that all migrations are ultimately squashed in a
single commit in the `forgejo-development` branch instead of an ever
growing list of commits. But this is up to the person in charge of the
migrations and since the directory is owned by forgejo, there is no
risk of conflict.
2023-08-13 17:10:14 +01:00
Earl Warren
2f75787cf8
docs: developer: workflow: no per-branch backports
Since the new release process involves using a single branch for
stable branches, the backport is no longer done on a per-branch basis.
2023-08-13 17:10:14 +01:00
Earl Warren
d1b6f00b45
docs: admin: storage: create a new section 2023-08-13 17:10:14 +01:00
Earl Warren
bb6b1a39b5
docs: admin: config-cheat-sheet: workers are dynamic now 2023-08-13 17:10:14 +01:00
Earl Warren
b6b56cd620
docs: admin: config-cheat-sheet: remove spurious line 2023-08-13 17:10:14 +01:00
Caesar Schinas
e688f3324b
fix: remove h1-level headings in docs
Increases depth of markdown headings to avoid 1st-level headings

# Conflicts:
#	v1.19/user/project.md
#	v1.19/user/protection.md
#	v1.19/user/push-to-create.md
2023-08-13 17:08:33 +01:00
Earl Warren
85a71e3c09
docs: admin: installation fix broken link
Fixes: https://codeberg.org/forgejo/website/issues/324
2023-08-13 17:07:45 +01:00
Caesar Schinas
9af05bfb01
refactor: use astro content collections for docs
Reviewed-on: https://codeberg.org/forgejo/website/pulls/323

# Conflicts:
#	v1.19/admin/command-line.md
#	v1.19/admin/config-cheat-sheet.md
#	v1.19/admin/database-preparation.md
#	v1.19/admin/email-setup.md
#	v1.19/admin/incoming-email.md
#	v1.19/admin/index.md
#	v1.19/admin/logging-documentation.md
#	v1.19/admin/reverse-proxy.md
#	v1.19/admin/seek-assistance.md
#	v1.19/admin/upgrade.md
#	v1.19/developer/code-forgejo-org.md
#	v1.19/developer/index.md
#	v1.19/index.md
#	v1.19/license.md
#	v1.19/user/agit-support.md
#	v1.19/user/api-usage.md
#	v1.19/user/authentication.md
#	v1.19/user/email-settings.md
#	v1.19/user/first-repository.md
#	v1.19/user/index.md
#	v1.19/user/issue-pull-request-templates.md
#	v1.19/user/issue-tracking-basics.md
#	v1.19/user/labels.md
#	v1.19/user/linked-references.md
#	v1.19/user/merge-message-templates.md
#	v1.19/user/oauth2-provider.md
#	v1.19/user/packages/cargo.md
#	v1.19/user/packages/chef.md
#	v1.19/user/packages/composer.md
#	v1.19/user/packages/conan.md
#	v1.19/user/packages/conda.md
#	v1.19/user/packages/container.md
#	v1.19/user/packages/generic.md
#	v1.19/user/packages/helm.md
#	v1.19/user/packages/index.md
#	v1.19/user/packages/maven.md
#	v1.19/user/packages/npm.md
#	v1.19/user/packages/nuget.md
#	v1.19/user/packages/pub.md
#	v1.19/user/packages/pypi.md
#	v1.19/user/packages/rubygems.md
#	v1.19/user/packages/storage.md
#	v1.19/user/packages/vagrant.md
#	v1.19/user/project.md
#	v1.19/user/protection.md
#	v1.19/user/push-options.md
#	v1.19/user/push-to-create.md
#	v1.19/user/repo-permissions.md
#	v1.19/user/webhooks.md
#	v1.19/user/wiki.md
#	v1.20/user/semver.md
2023-08-13 17:07:06 +01:00
Earl Warren
773be6dca2
refresh the installation guide with 1.20 2023-08-13 17:00:28 +01:00
Cyborus
8ad4341dd6
"loose" should be "lose"
# Conflicts:
#	v1.19/admin/upgrade.md
2023-08-13 16:59:46 +01:00
Peter Keenan
10f14eff87
Annotate localhost types 2023-08-13 16:37:04 +01:00
Peter Keenan
d6b2987330
Add host specific rules for pg_hba.conf section 2023-08-13 16:37:03 +01:00
Earl Warren
d87ee56faa
docs: admin: add missing documentation for WORK_PATH in app.ini
Refs: https://codeberg.org/forgejo/forgejo/issues/1118#issuecomment-1008533
2023-08-13 16:36:52 +01:00
Loïc Dachary
60aca1b265
docs: user: profile: document user custom profiles
# Conflicts:
#	user/profile.md
2023-08-13 16:36:21 +01:00
Loïc Dachary
38474aaa62
docs: user: authentication: move token scope out of the oauth2 section
# Conflicts:
#	user/token-scope.md
2023-08-13 16:36:21 +01:00
chrysn
5528363904
Add guidance for using podman with the runner 2023-08-13 16:36:21 +01:00
Earl Warren
0038bd1de9
docs: admin: upgrade: update to match v1.20.1-0 2023-08-13 16:36:21 +01:00
Earl Warren
c4d72a3668
docs: developer: WORKFLOW: rebase pull requests 2023-08-13 16:36:21 +01:00
Earl Warren
19ec284d9b
docs: admin: actions: typo - remove extra quote 2023-08-13 16:36:21 +01:00