Mercurial > piecrust2

comparison docs/pages/support.md @ 1077:c53af44457b6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Add some information about migrating from v2 to v3.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 15 Feb 2018 18:37:06 -0800
parents 94d7d5e38571
children
comparison
equal deleted inserted replaced
1076:2b2872bcff1f 1077:c53af44457b6
2 title: Support 2 title: Support
3 header_class: pc-support 3 header_class: pc-support
4 nav_key: support 4 nav_key: support
5 --- 5 ---
6 6
7 ## Changelog
8
7 Want to know what's new with PieCrust? Check out the [CHANGELOG][ch]. 9 Want to know what's new with PieCrust? Check out the [CHANGELOG][ch].
10
11
12 ## General Support
8 13
9 If you have a problem with PieCrust, there are a few ways to solve it: 14 If you have a problem with PieCrust, there are a few ways to solve it:
10 15
11 * Check the [documentation][doc] one more time! You never know, the solution may be in 16 * Check the [documentation][doc] one more time! You never know, the solution may be in
12 there. 17 there.
17 [BitBucket][bbbug] or [Github][ghbug]. If by chance you've already fixed it, 22 [BitBucket][bbbug] or [Github][ghbug]. If by chance you've already fixed it,
18 even better! Make a pull request, you know the drill. 23 even better! Make a pull request, you know the drill.
19 * If you have questions, hit the [me][] on [Twitter][]. 24 * If you have questions, hit the [me][] on [Twitter][].
20 25
21 26
27 ## Upgrading PieCrust
28
29 ### Version 2 to 3
30
31 Several things have changed between version 2 and 3, and some of them introduce
32 breaking changes.
33
34 #### Generated page templates
35
36 Previously, taxonomy listing pages had their template defined as a page with
37 a special name. For instance, tag lists were by default defined by
38 `pages/_tag.html`.
39
40 Now those page templates are proper templates, found in the `templates`
41 directory (or other if you changed that). The tag list is now
42 `templates/_tag.html` for instance.
43
44 In general, you should only have to move your template for the `pages` folder to
45 the `templates` folder.
46
47 #### Generators
48
49 There is no more `generators` in the website configuration -- everything is
50 a content source. If you had custom generators in their, you will need to
51 re-declare them as standard sources.
52
53 For example, a new taxonomy source would be defined like this:
54
55 ```
56 site:
57 sources:
58 post_tags:
59 type: taxonomy
60 taxonomy: tags
61 source: posts
62 ```
63
64 In this example, `tags` is a taxonomy declared the same way as previously inside
65 `site/taxonomies`, and `posts` is a normal page source declared also in the same
66 way as previously.
67
68
22 [doc]: {{docurl('')}} 69 [doc]: {{docurl('')}}
23 [ch]: {{pcurl('support/changelog')}} 70 [ch]: {{pcurl('support/changelog')}}
24 [bbsrc]: https://bitbucket.org/ludovicchabant/piecrust2 71 [bbsrc]: https://bitbucket.org/ludovicchabant/piecrust2
25 [bbbug]: https://bitbucket.org/ludovicchabant/piecrust2/issues?status=new&status=open 72 [bbbug]: https://bitbucket.org/ludovicchabant/piecrust2/issues?status=new&status=open
26 [ghsrc]: https://github.com/ludovicchabant/PieCrust2 73 [ghsrc]: https://github.com/ludovicchabant/PieCrust2