Fossil SCM
Rename "event" to "technote" throughout technote/event documentation. Previous renaming did not address every instance of the word "event".
Commit
dc359323be5c482ffaf5c83359fd4b15c8e88417
Parent
d19b52a3cfa6d3f…
1 file changed
+9
-9
+9
-9
| --- www/event.wiki | ||
| +++ www/event.wiki | ||
| @@ -7,54 +7,54 @@ | ||
| 7 | 7 | that is associated with a point in time rather than having a page name. |
| 8 | 8 | Each technote causes a single entry to appear on the |
| 9 | 9 | [/timeline?y=e | Timeline Page]. |
| 10 | 10 | Clicking on the timeline link will display the text of the technote. |
| 11 | 11 | The wiki content, the timeline entry text, the |
| 12 | -time of the event, and the timeline background color can all be edited. | |
| 12 | +time of the technote, and the timeline background color can all be edited. | |
| 13 | 13 | |
| 14 | 14 | As with check-ins, wiki, and tickets, all technotes automatically synchronize |
| 15 | 15 | to other repositories. Hence, technotes can be viewed, created, and edited |
| 16 | 16 | off-line. And the complete edit history for technotes is maintained |
| 17 | 17 | for auditing purposes. |
| 18 | 18 | |
| 19 | -Possible uses for events include: | |
| 19 | +Possible uses for technotes include: | |
| 20 | 20 | |
| 21 | 21 | * <b>Milestones</b>. Project milestones, such as releases or beta-test |
| 22 | - cycles, can be recorded as events. The timeline entry for the event | |
| 22 | + cycles, can be recorded as technotes. The timeline entry for the technote | |
| 23 | 23 | can be something simple like "Version 1.2.3" perhaps with a bright |
| 24 | 24 | color background to draw attention to the entry and the wiki content |
| 25 | 25 | can contain release notes, for example. |
| 26 | 26 | |
| 27 | 27 | * <b>Blog Entries</b>. Blog entries from developers describing the current |
| 28 | 28 | state of a project, or rational for various design decisions, or |
| 29 | - roadmaps for future development, can be entered as events. | |
| 29 | + roadmaps for future development, can be entered as technotes. | |
| 30 | 30 | |
| 31 | 31 | * <b>Process Checkpoints</b>. For projects that have a formal process, |
| 32 | - events can be used to record the completion or the initiation of | |
| 33 | - various process steps. For example, an event can be used to record | |
| 32 | + technotes can be used to record the completion or the initiation of | |
| 33 | + various process steps. For example, a technote can be used to record | |
| 34 | 34 | the successful completion of a long-running test, perhaps with |
| 35 | 35 | performance results and details of where the test was run and who |
| 36 | 36 | ran it recorded in the wiki content. |
| 37 | 37 | |
| 38 | 38 | * <b>News Articles</b>. Significant occurrences in the lifecycle of |
| 39 | - a project can be recorded as news articles using events. Perhaps the | |
| 39 | + a project can be recorded as news articles using technotes. Perhaps the | |
| 40 | 40 | domain name of the canonical website for a project changes, or new |
| 41 | 41 | server hardware is obtained. Such happenings are appropriate for |
| 42 | 42 | reporting as news. |
| 43 | 43 | |
| 44 | 44 | * <b>Announcements</b>. Changes to the composition of the development |
| 45 | 45 | team or acquisition of new project sponsors can be communicated as |
| 46 | - announcements which can be implemented as events. | |
| 46 | + announcements which can be implemented as technotes. | |
| 47 | 47 | |
| 48 | 48 | No project is required to use technotes. But technotes can help many projects |
| 49 | 49 | stay better organized and provide a better historical record of the |
| 50 | 50 | development progress. |
| 51 | 51 | |
| 52 | 52 | <h2>Viewing Technotes</h2> |
| 53 | 53 | |
| 54 | 54 | Because technotes are considered a special kind of wiki, |
| 55 | -users must have permission to read wiki in order read events. | |
| 55 | +users must have permission to read wiki in order read technotes. | |
| 56 | 56 | Enable the "j" permission under the /Setup/Users menu in order |
| 57 | 57 | to give specific users or user classes the ability to view wiki |
| 58 | 58 | and technotes. |
| 59 | 59 | |
| 60 | 60 | Technotes show up on the timeline. Click on the hyperlink beside the |
| 61 | 61 |
| --- www/event.wiki | |
| +++ www/event.wiki | |
| @@ -7,54 +7,54 @@ | |
| 7 | that is associated with a point in time rather than having a page name. |
| 8 | Each technote causes a single entry to appear on the |
| 9 | [/timeline?y=e | Timeline Page]. |
| 10 | Clicking on the timeline link will display the text of the technote. |
| 11 | The wiki content, the timeline entry text, the |
| 12 | time of the event, and the timeline background color can all be edited. |
| 13 | |
| 14 | As with check-ins, wiki, and tickets, all technotes automatically synchronize |
| 15 | to other repositories. Hence, technotes can be viewed, created, and edited |
| 16 | off-line. And the complete edit history for technotes is maintained |
| 17 | for auditing purposes. |
| 18 | |
| 19 | Possible uses for events include: |
| 20 | |
| 21 | * <b>Milestones</b>. Project milestones, such as releases or beta-test |
| 22 | cycles, can be recorded as events. The timeline entry for the event |
| 23 | can be something simple like "Version 1.2.3" perhaps with a bright |
| 24 | color background to draw attention to the entry and the wiki content |
| 25 | can contain release notes, for example. |
| 26 | |
| 27 | * <b>Blog Entries</b>. Blog entries from developers describing the current |
| 28 | state of a project, or rational for various design decisions, or |
| 29 | roadmaps for future development, can be entered as events. |
| 30 | |
| 31 | * <b>Process Checkpoints</b>. For projects that have a formal process, |
| 32 | events can be used to record the completion or the initiation of |
| 33 | various process steps. For example, an event can be used to record |
| 34 | the successful completion of a long-running test, perhaps with |
| 35 | performance results and details of where the test was run and who |
| 36 | ran it recorded in the wiki content. |
| 37 | |
| 38 | * <b>News Articles</b>. Significant occurrences in the lifecycle of |
| 39 | a project can be recorded as news articles using events. Perhaps the |
| 40 | domain name of the canonical website for a project changes, or new |
| 41 | server hardware is obtained. Such happenings are appropriate for |
| 42 | reporting as news. |
| 43 | |
| 44 | * <b>Announcements</b>. Changes to the composition of the development |
| 45 | team or acquisition of new project sponsors can be communicated as |
| 46 | announcements which can be implemented as events. |
| 47 | |
| 48 | No project is required to use technotes. But technotes can help many projects |
| 49 | stay better organized and provide a better historical record of the |
| 50 | development progress. |
| 51 | |
| 52 | <h2>Viewing Technotes</h2> |
| 53 | |
| 54 | Because technotes are considered a special kind of wiki, |
| 55 | users must have permission to read wiki in order read events. |
| 56 | Enable the "j" permission under the /Setup/Users menu in order |
| 57 | to give specific users or user classes the ability to view wiki |
| 58 | and technotes. |
| 59 | |
| 60 | Technotes show up on the timeline. Click on the hyperlink beside the |
| 61 |
| --- www/event.wiki | |
| +++ www/event.wiki | |
| @@ -7,54 +7,54 @@ | |
| 7 | that is associated with a point in time rather than having a page name. |
| 8 | Each technote causes a single entry to appear on the |
| 9 | [/timeline?y=e | Timeline Page]. |
| 10 | Clicking on the timeline link will display the text of the technote. |
| 11 | The wiki content, the timeline entry text, the |
| 12 | time of the technote, and the timeline background color can all be edited. |
| 13 | |
| 14 | As with check-ins, wiki, and tickets, all technotes automatically synchronize |
| 15 | to other repositories. Hence, technotes can be viewed, created, and edited |
| 16 | off-line. And the complete edit history for technotes is maintained |
| 17 | for auditing purposes. |
| 18 | |
| 19 | Possible uses for technotes include: |
| 20 | |
| 21 | * <b>Milestones</b>. Project milestones, such as releases or beta-test |
| 22 | cycles, can be recorded as technotes. The timeline entry for the technote |
| 23 | can be something simple like "Version 1.2.3" perhaps with a bright |
| 24 | color background to draw attention to the entry and the wiki content |
| 25 | can contain release notes, for example. |
| 26 | |
| 27 | * <b>Blog Entries</b>. Blog entries from developers describing the current |
| 28 | state of a project, or rational for various design decisions, or |
| 29 | roadmaps for future development, can be entered as technotes. |
| 30 | |
| 31 | * <b>Process Checkpoints</b>. For projects that have a formal process, |
| 32 | technotes can be used to record the completion or the initiation of |
| 33 | various process steps. For example, a technote can be used to record |
| 34 | the successful completion of a long-running test, perhaps with |
| 35 | performance results and details of where the test was run and who |
| 36 | ran it recorded in the wiki content. |
| 37 | |
| 38 | * <b>News Articles</b>. Significant occurrences in the lifecycle of |
| 39 | a project can be recorded as news articles using technotes. Perhaps the |
| 40 | domain name of the canonical website for a project changes, or new |
| 41 | server hardware is obtained. Such happenings are appropriate for |
| 42 | reporting as news. |
| 43 | |
| 44 | * <b>Announcements</b>. Changes to the composition of the development |
| 45 | team or acquisition of new project sponsors can be communicated as |
| 46 | announcements which can be implemented as technotes. |
| 47 | |
| 48 | No project is required to use technotes. But technotes can help many projects |
| 49 | stay better organized and provide a better historical record of the |
| 50 | development progress. |
| 51 | |
| 52 | <h2>Viewing Technotes</h2> |
| 53 | |
| 54 | Because technotes are considered a special kind of wiki, |
| 55 | users must have permission to read wiki in order read technotes. |
| 56 | Enable the "j" permission under the /Setup/Users menu in order |
| 57 | to give specific users or user classes the ability to view wiki |
| 58 | and technotes. |
| 59 | |
| 60 | Technotes show up on the timeline. Click on the hyperlink beside the |
| 61 |