tqt
/
Ghost
mirror of https://github.com/TryGhost/Ghost.git
2
1
Fork 0
Code Issues 1 Releases Wiki Activity
Ghost/content/settings/README.md

22 lines
327 B
Markdown
Raw Normal View History

Added `content/settings` folder refs #9528 refs TryGhost/Ghost-CLI#681 - added a new `/content/settings` folder - bumped Ghost-CLI engine requirement to >= 1.7.0
2018-04-13 03:29:36 +02:00
# Content / Settings
### routes.yaml
<!-- TODO: make a better description here and link to the docs -->
This is how the default `routes.yaml` file looks like:
```yaml
routes:
collections:
/:
✨Dynamic Routing Beta (#9596) refs #9601 ### Dynamic Routing This is the beta version of dynamic routing. - we had a initial implementation of "channels" available in the codebase - we have removed and moved this implementation - there is now a centralised place for dynamic routing - server/services/routing - each routing component is represented by a router type e.g. collections, routes, static pages, taxonomies, rss, preview of posts - keep as much as possible logic of routing helpers, middlewares and controllers - ensure test coverage - connect all the things together - yaml file + validation - routing + routers - url service - sitemaps - url access - deeper implementation of yaml validations - e.g. hard require slashes - ensure routing hierarchy/order - e.g. you enable the subscriber app - you have a custom static page, which lives under the same slug /subscribe - static pages are stronger than apps - e.g. the first collection owns the post it has filtered - a post cannot live in two collections - ensure apps are still working and hook into the routers layer (or better said: and register in the routing service) - put as much as possible comments to the code base for better understanding - ensure a clean debug log - ensure we can unmount routes - e.g. you have a collection permalink of /:slug/ represented by {globals.permalink} - and you change the permalink in the admin to dated permalink - the express route get's refreshed from /:slug/ to /:year/:month/:day/:slug/ - unmount without server restart, yey - ensure we are backwards compatible - e.g. render home.hbs for collection index if collection route is / - ensure you can access your configured permalink from the settings table with {globals.permalink} ### Render 503 if url service did not finish - return 503 if the url service has not finished generating the resource urls ### Rewrite sitemaps - we have rewritten the sitemaps "service", because the url generator does no longer happen on runtime - we generate all urls on bootstrap - the sitemaps service will consume created resource and router urls - these urls will be shown on the xml pages - we listen on url events - we listen on router events - we no longer have to fetch the resources, which is nice - the urlservice pre-fetches resources and emits their urls - the urlservice is the only component who knows which urls are valid - i made some ES6 adaptions - we keep the caching logic -> only regenerate xml if there is a change - updated tests - checked test coverage (100%) ### Re-work usage of Url utility - replace all usages of `urlService.utils.urlFor` by `urlService.getByResourceId` - only for resources e.g. post, author, tag - this is important, because with dynamic routing we no longer create static urls based on the settings permalink on runtime - adapt url utility - adapt tests
2018-06-05 19:02:20 +02:00
permalink: '{globals.permalinks}'
Added `content/settings` folder refs #9528 refs TryGhost/Ghost-CLI#681 - added a new `/content/settings` folder - bumped Ghost-CLI engine requirement to >= 1.7.0
2018-04-13 03:29:36 +02:00
template:
- index
Updated content/settings/README.md no issue - the name of the routing type was incorrect - we have 1. routes: static routes (or series later) 2. collections: a collection of posts 3. taxonomies: configuration for author and tag routes - see equivalent: https://github.com/TryGhost/Ghost/blob/1.23.1/core/server/services/settings/default-routes.yaml
2018-06-01 19:36:48 +02:00
taxonomies:
Added `content/settings` folder refs #9528 refs TryGhost/Ghost-CLI#681 - added a new `/content/settings` folder - bumped Ghost-CLI engine requirement to >= 1.7.0
2018-04-13 03:29:36 +02:00
tag: /tag/{slug}/
author: /author/{slug}/
```