diff options
| author | Evan Read <eread@gitlab.com> | 2018-11-13 09:07:16 +0300 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-01-08 05:21:09 +0300 |
| commit | d98560c1f5c54127d1a48c4c8e326bbf06c31c4b (patch) | |
| tree | b2d2fc26829e0a7b25da18d09a1e7e07ba1efed8 /doc/development/file_storage.md | |
| parent | 710f2ec50c49d1e773acc20058ed584f1402de33 (diff) | |
Make unordered lists conform to styleguide
- Also makes other minor Markdown fixes that were near the main fixes.
Diffstat (limited to 'doc/development/file_storage.md')
| -rw-r--r-- | doc/development/file_storage.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/development/file_storage.md b/doc/development/file_storage.md index 6e014e8c751..b90dc90e424 100644 --- a/doc/development/file_storage.md +++ b/doc/development/file_storage.md @@ -4,15 +4,15 @@ We use the [CarrierWave] gem to handle file upload, store and retrieval. There are many places where file uploading is used, according to contexts: -* System +- System - Instance Logo (logo visible in sign in/sign up pages) - Header Logo (one displayed in the navigation bar) -* Group +- Group - Group avatars -* User +- User - User avatars - User snippet attachments -* Project +- Project - Project avatars - Issues/MR/Notes Markdown attachments - Issues/MR/Notes Legacy Markdown attachments @@ -52,7 +52,7 @@ hash of the project ID instead, if project migrates to the new approach (introdu ### Path segments -Files are stored at multiple locations and use different path schemes. +Files are stored at multiple locations and use different path schemes. All the `GitlabUploader` derived classes should comply with this path segment schema: ``` @@ -61,7 +61,7 @@ All the `GitlabUploader` derived classes should comply with this path segment sc | `<gitlab_root>/public/` | `uploads/-/system/` | `user/avatar/:id/` | `:filename` | | ----------------------- + ------------------------- + --------------------------------- + -------------------------------- | | `CarrierWave.root` | `GitlabUploader.base_dir` | `GitlabUploader#dynamic_segment` | `CarrierWave::Uploader#filename` | -| | `CarrierWave::Uploader#store_dir` | | +| | `CarrierWave::Uploader#store_dir` | | | FileUploader | ----------------------- + ------------------------- + --------------------------------- + -------------------------------- | @@ -69,7 +69,7 @@ All the `GitlabUploader` derived classes should comply with this path segment sc | `<gitlab_root>/shared/` | `snippets/` | `:secret/` | `:filename` | | ----------------------- + ------------------------- + --------------------------------- + -------------------------------- | | `CarrierWave.root` | `GitlabUploader.base_dir` | `GitlabUploader#dynamic_segment` | `CarrierWave::Uploader#filename` | -| | `CarrierWave::Uploader#store_dir` | | +| | `CarrierWave::Uploader#store_dir` | | | | | `FileUploader#upload_path | | ObjectStore::Concern (store = remote) @@ -77,7 +77,7 @@ All the `GitlabUploader` derived classes should comply with this path segment sc | `<bucket_name>` | <ignored> | `user/avatar/:id/` | `:filename` | | ----------------------- + ------------------------- + ----------------------------------- + -------------------------------- | | `#fog_dir` | `GitlabUploader.base_dir` | `GitlabUploader#dynamic_segment` | `CarrierWave::Uploader#filename` | -| | | `ObjectStorage::Concern#store_dir` | | +| | | `ObjectStorage::Concern#store_dir` | | | | | `ObjectStorage::Concern#upload_path | ``` |