diff options
author | wxiaoguang <wxiaoguang@gmail.com> | 2023-07-19 00:06:43 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-18 18:06:43 +0200 |
commit | faa28b5a44912f1c63afddab9396bae9e6fe061c (patch) | |
tree | 0a3abf5922acc88887e83082994852c9ec822bb5 /docs/content/doc/development | |
parent | 8af96f585f83ff5c0000f0395dab52b02517abe3 (diff) | |
download | gitea-faa28b5a44912f1c63afddab9396bae9e6fe061c.tar.gz gitea-faa28b5a44912f1c63afddab9396bae9e6fe061c.zip |
Move public asset files to the proper directory (#25907)
Move `public/*` to `public/assets/*`
Some old PRs (like #15219) introduced inconsistent directory system.
For example: why the local directory "public" is accessed by
`http://site/assets`? How to serve the ".well-known" files properly in
the public directory?
For convention rules, the "public" directory is widely used for the
website's root directory. It shouldn't be an exception for Gitea.
So, this PR makes the things consistent:
* `http://site/assets/foo` means `{CustomPath}/public/assets/foo`.
* `{CustomPath}/public/.well-known` and `{CustomPath}/public/robots.txt`
can be used in the future.
This PR is also a prerequisite for a clear solution for:
* #21942
* #25892
* discourse.gitea.io: [.well-known path serving custom files behind
proxy?](https://discourse.gitea.io/t/well-known-path-serving-custom-files-behind-proxy/5445/1)
This PR is breaking for users who have custom "public" files (CSS/JS).
After getting approvals, I will update the documents.
----
## ⚠️ BREAKING ⚠️
If you have files in your "custom/public/" folder, please move them to
"custom/public/assets/".
---------
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Giteabot <teabot@gitea.io>
Diffstat (limited to 'docs/content/doc/development')
-rw-r--r-- | docs/content/doc/development/hacking-on-gitea.en-us.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/content/doc/development/hacking-on-gitea.en-us.md b/docs/content/doc/development/hacking-on-gitea.en-us.md index c13f223919..e1efe2ec11 100644 --- a/docs/content/doc/development/hacking-on-gitea.en-us.md +++ b/docs/content/doc/development/hacking-on-gitea.en-us.md @@ -218,7 +218,7 @@ REPO_INDEXER_CONN_STR = http://elastic:changeme@localhost:9200 ### Building and adding SVGs -SVG icons are built using the `make svg` target which compiles the icon sources defined in `build/generate-svg.js` into the output directory `public/img/svg`. Custom icons can be added in the `web_src/svg` directory. +SVG icons are built using the `make svg` target which compiles the icon sources defined in `build/generate-svg.js` into the output directory `public/assets/img/svg`. Custom icons can be added in the `web_src/svg` directory. ### Building the Logo |