Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 5270:84a844f50d1f
Set min python version for release 1.6. Login changes now required,
fix incorrect file name, add filename for keyword entry improvement.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 20 Sep 2017 22:50:43 -0400 |
| parents | 64ae2108df60 |
| children | bee4008a2840 |
comparison
equal
deleted
inserted
replaced
| 5269:c94fd717e28c | 5270:84a844f50d1f |
|---|---|
| 9 If a specific version transition isn't mentioned here (eg. 0.6.7 to 0.6.8) | 9 If a specific version transition isn't mentioned here (eg. 0.6.7 to 0.6.8) |
| 10 then you don't need to do anything. If you're upgrading from 0.5.6 to | 10 then you don't need to do anything. If you're upgrading from 0.5.6 to |
| 11 0.6.8 though, you'll need to check the "0.5 to 0.6" and "0.6.x to 0.6.3" | 11 0.6.8 though, you'll need to check the "0.5 to 0.6" and "0.6.x to 0.6.3" |
| 12 steps. | 12 steps. |
| 13 | 13 |
| 14 **IMPORTANT** The v1.5.x releases of Roundup will be the last to support Python | 14 **IMPORTANT** The v1.5.x releases of Roundup will be the last to |
| 15 v2.5. Support for Python v2.5 will be dropped with the v1.6 release of Roundup, | 15 support Python v2.5. Support for Python v2.5 and v2.66 will be dropped |
| 16 at which point users will need to run Roundup using either Python v2.6 or v2.7. | 16 with the v1.6 release of Roundup. Roundup 1.6 and newer require |
| 17 Python v2.7. | |
| 17 | 18 |
| 18 Contents: | 19 Contents: |
| 19 | 20 |
| 20 .. contents:: | 21 .. contents:: |
| 21 :local: | 22 :local: |
| 246 # address. It must be a valid RFC2822 address or people will not be | 247 # address. It must be a valid RFC2822 address or people will not be |
| 247 # able to reply. | 248 # able to reply. |
| 248 # Default: | 249 # Default: |
| 249 replyto_address = | 250 replyto_address = |
| 250 | 251 |
| 251 Login from a search or after logout works better | 252 Login from a search or after logout works better (REQUIRED) |
| 252 ------------------------------------------------ | 253 ----------------------------------------------------------- |
| 253 | 254 |
| 254 The login form has been improved to work with some back end code | 255 The login form has been improved to work with some back end code |
| 255 changes. Now when a user logs in they stay on the same page where they | 256 changes. Now when a user logs in they stay on the same page where they |
| 256 started the login. To make this work, you must change the tal that is | 257 started the login. To make this work, you must change the tal that is |
| 257 used to set the ``__came_from`` form variable. Note that the url | 258 used to set the ``__came_from`` form variable. Note that the url |
| 287 <form method="post" tal:attributes="action string:${request/env/PATH_INFO}"> | 288 <form method="post" tal:attributes="action string:${request/env/PATH_INFO}"> |
| 288 | 289 |
| 289 the important part is that the action field **must not** include any query | 290 the important part is that the action field **must not** include any query |
| 290 parameters ('#' includes query params). | 291 parameters ('#' includes query params). |
| 291 | 292 |
| 293 One symptom of failing to do this is getting an error: | |
| 294 | |
| 295 Unrecognized scheme in .... | |
| 296 | |
| 297 where the .... changes depending on the url path. You can see this | |
| 298 when logging in from any screen other than the main index. | |
| 299 | |
| 292 Option to make adding multiple keywords more convenient | 300 Option to make adding multiple keywords more convenient |
| 293 ------------------------------------------------------- | 301 ------------------------------------------------------- |
| 294 | 302 |
| 295 In the classic tracker, after adding a new keyword you are redirected | 303 In the classic tracker, after adding a new keyword you are redirected |
| 296 to the page for the new keyword so you can change the keyword's | 304 to the page for the new keyword so you can change the keyword's |
| 298 keyword's name when creating the keyword. The new classic tracker has | 306 keyword's name when creating the keyword. The new classic tracker has |
| 299 a new checkbox (checked by default) that keeps you on the same page so | 307 a new checkbox (checked by default) that keeps you on the same page so |
| 300 you can add a new keywords one after the other. | 308 you can add a new keywords one after the other. |
| 301 | 309 |
| 302 To add this to your own tracker, add the following code (prefixed with | 310 To add this to your own tracker, add the following code (prefixed with |
| 303 a +) after the entry box for the new keyword:: | 311 a +) after the entry box for the new keyword in html/keyword.item.html:: |
| 304 | 312 |
| 305 <tr> | 313 <tr> |
| 306 <th i18n:translate="">Keyword</th> | 314 <th i18n:translate="">Keyword</th> |
| 307 <td tal:content="structure context/name/field">name</td> | 315 <td tal:content="structure context/name/field">name</td> |
| 308 + <td tal:condition="not:context/id"> | 316 + <td tal:condition="not:context/id"> |
| 326 The key component here is support for the '__redirect_to' query | 334 The key component here is support for the '__redirect_to' query |
| 327 property. It is a url which can be used when creating any new item | 335 property. It is a url which can be used when creating any new item |
| 328 (issue, user, keyword ....). It controls the next page displayed after | 336 (issue, user, keyword ....). It controls the next page displayed after |
| 329 creating the item. If '__redirect_to' is not set, then you end up on | 337 creating the item. If '__redirect_to' is not set, then you end up on |
| 330 the page for the newly created item. The url value assigned to | 338 the page for the newly created item. The url value assigned to |
| 331 __redirect_to must be under the tracker's base url and must be properly | 339 __redirect_to must start with the tracker's base url and must be properly |
| 332 url encoded. | 340 url encoded. |
| 333 | 341 |
| 334 Helper popups trigger change events on the original page | 342 Helper popups trigger change events on the original page |
| 335 -------------------------------------------------------- | 343 -------------------------------------------------------- |
| 336 | 344 |
| 547 default the query editing page (issue.search.html) displays the index | 555 default the query editing page (issue.search.html) displays the index |
| 548 page when the search is triggered. This is usually correct since the | 556 page when the search is triggered. This is usually correct since the |
| 549 user expects to see the results of the query. But now that | 557 user expects to see the results of the query. But now that |
| 550 the code properly checks for duplicate search names, the user should | 558 the code properly checks for duplicate search names, the user should |
| 551 stay on the search page if there is an error. To add this to your | 559 stay on the search page if there is an error. To add this to your |
| 552 existing index.search.html page, add the following line after the | 560 existing issue.search.html page, add the following line after the |
| 553 hidden field @old-queryname: | 561 hidden field @old-queryname: |
| 554 | 562 |
| 555 <input type="hidden" name="@template" value="index|search"/> | 563 <input type="hidden" name="@template" value="index|search"/> |
| 556 | 564 |
| 557 With this addition, the index template is displayed if there is no | 565 With this addition, the index template is displayed if there is no |