gitea/docs
zeripath 9c2b7a196e
Disable core.protectNTFS () ()
Backport 

core.protectNTFS protects NTFS from files which may be difficult to remove or interact
with using the win32 api, however, it also appears to prevent such files from
being entered into the git indexes - fundamentally causing breakages with PRs that
affect these files. However, deliberately setting this to false may cause security
issues due to the remain sparse checkout of files in the merge pipeline.

The only sensible option therefore is to provide an optional setting which admins
could set which would forcibly switch this off if they are affected by this issue.

Fix 

Signed-off-by: Andrew Thornton <art27@cantab.net>
2021-10-13 23:02:45 +03:00
..
assets/js Modernize docs/assets/js/search.js () 2020-03-08 21:41:52 -03:00
content Disable core.protectNTFS () () 2021-10-13 23:02:45 +03:00
layouts Add node version variable to docs () 2020-03-05 16:36:22 -06:00
scripts Fix building of docs with latest hugo version () 2018-04-28 23:46:05 +03:00
static Self-host cloudron image for docs () 2020-12-07 22:20:37 -05:00
.gitignore Implement documentation search () 2019-11-13 18:03:18 +00:00
config.yaml release/v1.15: set min go version to min upstream supported go1.16 () 2021-08-17 10:09:44 +03:00
LICENSE Import docs into main repository () 2017-11-26 23:44:32 +02:00
Makefile follow redirect when fetching theme archive () 2021-05-26 18:03:39 -04:00
README.md Update to docs README () 2019-03-01 15:39:30 -05:00
README_ZH.md update discord link () 2020-02-25 12:36:45 -05:00

Gitea: Docs

Join the chat at https://img.shields.io/discord/322538954119184384.svg

Hosting

These pages are hosted using netlifycms and get automatically updated on every push to the master branch.

Install

These pages use the Hugo static site generator. If you are planning to contribute you'll want to download and install Hugo on your local machine.

The installation of Hugo is out of the scope of this document, so please take the official install instructions to get Hugo up and running.

Development

To generate the website and serve it on localhost:1313 just execute this command and stop it with Ctrl+C:

make server

When you are done with your changes just create a pull request, after merging the pull request the website will be updated automatically.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

This project is under the Apache-2.0 License. See the LICENSE file for the full license text.

Copyright (c) 2016 The Gitea Authors <https://gitea.io>