mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-07-04 21:13:18 +02:00
bb25f85ce8
This was intended to be a small followup for https://github.com/go-gitea/gitea/pull/23712, but...here we are. 1. Our docs currently use `slug` as the entire URL, which makes refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712). Instead, this PR attempts to make future refactoring easier by using slugs as an extension of the section. (Hugo terminology) - What the above boils down to is this PR attempts to use directory organization as URL management. e.g. `usage/comparison.en-us.md` -> `en-us/usage/comparison/`, `usage/packages/overview.en-us.md` -> `en-us/usage/packages/overview/` - Technically we could even remove `slug`, as Hugo defaults to using filename, however at least with this PR it means `slug` only needs to be the name for the **current file** rather than an entire URL 2. This PR adds appropriate aliases (redirects) for pages, so anything on the internet that links to our docs should hopefully not break. 3. A minor nit I've had for a while, renaming `seek-help` to `support`. It's a minor thing, but `seek-help` has a strange connotation to it. 4. The commits are split such that you can review the first which is the "actual" change, and the second is added redirects so that the first doesn't break links elsewhere. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
---
|
|
date: "2019-12-28"
|
|
title: "Adding Legal Pages"
|
|
slug: adding-legal-pages
|
|
weight: 110
|
|
toc: false
|
|
draft: false
|
|
aliases:
|
|
- /en-us/adding-legal-pages
|
|
menu:
|
|
sidebar:
|
|
parent: "administration"
|
|
name: "Adding Legal Pages"
|
|
identifier: "adding-legal-pages"
|
|
weight: 110
|
|
---
|
|
|
|
Some jurisdictions (such as EU), requires certain legal pages (e.g. Privacy Policy) to be added to website. Follow these steps to add them to your Gitea instance.
|
|
|
|
## Getting Pages
|
|
|
|
Gitea source code ships with sample pages, available in `contrib/legal` directory. Copy them to `custom/public/`. For example, to add Privacy Policy:
|
|
|
|
```
|
|
wget -O /path/to/custom/public/privacy.html https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/legal/privacy.html.sample
|
|
```
|
|
|
|
Now you need to edit the page to meet your requirements. In particular you must change the email addresses, web addresses and references to "Your Gitea Instance" to match your situation.
|
|
|
|
You absolutely must not place a general ToS or privacy statement that implies that the Gitea project is responsible for your server.
|
|
|
|
## Make it Visible
|
|
|
|
Create or append to `/path/to/custom/templates/custom/extra_links_footer.tmpl`:
|
|
|
|
```go
|
|
<a class="item" href="{{AppSubUrl}}/assets/privacy.html">Privacy Policy</a>
|
|
```
|
|
|
|
Restart Gitea to see the changes.
|