From 92fb89f6e1a10d8431de536823a0680af417a04f Mon Sep 17 00:00:00 2001 From: techknowlogick Date: Sun, 4 Nov 2018 21:21:56 -0500 Subject: [PATCH] Clean up docs (#5274) * make docs more clear * make docs more clear * Add analytics * Update customizing-gitea.en-us.md * Update app.ini.sample --- custom/conf/app.ini.sample | 4 ++-- docs/content/doc/advanced/config-cheat-sheet.en-us.md | 4 ++-- docs/content/doc/advanced/customizing-gitea.en-us.md | 6 +++++- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/custom/conf/app.ini.sample b/custom/conf/app.ini.sample index a5925b48da..9e2b0b6958 100644 --- a/custom/conf/app.ini.sample +++ b/custom/conf/app.ini.sample @@ -265,9 +265,9 @@ COOKIE_REMEMBER_NAME = gitea_incredible REVERSE_PROXY_AUTHENTICATION_USER = X-WEBAUTH-USER ; The minimum password length for new Users MIN_PASSWORD_LENGTH = 6 -; True when users are allowed to import local server paths +; Set to true to allow users to import local server paths IMPORT_LOCAL_PATHS = false -; Prevent all users (including admin) from creating custom git hooks +; Set to true to prevent all users (including admin) from creating custom git hooks DISABLE_GIT_HOOKS = false [openid] diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md index 1c327f6073..a046fd0ca5 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md @@ -160,9 +160,9 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`. information. - `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: Header name for reverse proxy authentication. -- `DISABLE_GIT_HOOKS`: **false**: Prevent all users (including admin) from creating custom +- `DISABLE_GIT_HOOKS`: **false**: Set to `true` to prevent all users (including admin) from creating custom git hooks. -- `IMPORT_LOCAL_PATHS`: **false**: Prevent all users (including admin) from importing local path on server. +- `IMPORT_LOCAL_PATHS`: **false**: Set to `false` to prevent all users (including admin) from importing local path on server. ## OpenID (`openid`) diff --git a/docs/content/doc/advanced/customizing-gitea.en-us.md b/docs/content/doc/advanced/customizing-gitea.en-us.md index fed48ca988..7c8b683da5 100644 --- a/docs/content/doc/advanced/customizing-gitea.en-us.md +++ b/docs/content/doc/advanced/customizing-gitea.en-us.md @@ -88,10 +88,14 @@ Apart from `extra_links.tmpl` and `extra_tabs.tmpl`, there are other useful temp - `body_outer_post.tmpl`, before the bottom `