Fossil SCM
Documentation tweaks.
Commit
5d3ba8aa9005b1fd77ba934f11deb4fff180c06bca784be754fa8875701f272a
Parent
5797c7e8e9b214a…
3 files changed
+7
-4
+15
-14
+2
-1
+7
-4
| --- www/chat.md | ||
| +++ www/chat.md | ||
| @@ -6,23 +6,26 @@ | ||
| 6 | 6 | Fossil supports a developer chatroom feature. The chatroom provides an |
| 7 | 7 | ephemeral discussion venue for insiders. Design goals include: |
| 8 | 8 | |
| 9 | 9 | * **Simple but functional** → Fossil chat is designed to provide a |
| 10 | 10 | convenient real-time communication mechanism for geographically |
| 11 | - dispersed developers. Fossil chat is emphatically *not* intended | |
| 11 | + dispersed developers. Fossil chat is *not* intended | |
| 12 | 12 | as a replacement or |
| 13 | 13 | competitor for IRC, Slack, Discord, Telegram, Google Hangouts, etc. |
| 14 | 14 | |
| 15 | 15 | * **Low administration** → |
| 16 | - There is no additional set up or configuration. | |
| 17 | - Simply enable the [C capability](/setup_ucap_list) for users | |
| 16 | + You can activate the chatroom in seconds without having to | |
| 17 | + mess with configuration files or install new software. | |
| 18 | + In an existing [server setup](./server/), | |
| 19 | + simply enable the [C capability](/setup_ucap_list) for users | |
| 18 | 20 | whom you want to give access to the chatroom. |
| 19 | 21 | |
| 20 | 22 | * **Ephemeral** → |
| 21 | 23 | Chat messages do not sync to peer repositories. And they are |
| 22 | 24 | automatically deleted after a configurable delay (default: 7 days). |
| 23 | - They can be deleted at any time without impacting any other part | |
| 25 | + Individual messages or the entire conversation | |
| 26 | + can be deleted at any time without impacting any other part | |
| 24 | 27 | of the system. |
| 25 | 28 | |
| 26 | 29 | Fossil chat is designed for use by insiders - people with check-in |
| 27 | 30 | privileges or higher. It is not intended as a general-purpose gathering |
| 28 | 31 | place for random passers-by on the internet. |
| 29 | 32 |
| --- www/chat.md | |
| +++ www/chat.md | |
| @@ -6,23 +6,26 @@ | |
| 6 | Fossil supports a developer chatroom feature. The chatroom provides an |
| 7 | ephemeral discussion venue for insiders. Design goals include: |
| 8 | |
| 9 | * **Simple but functional** → Fossil chat is designed to provide a |
| 10 | convenient real-time communication mechanism for geographically |
| 11 | dispersed developers. Fossil chat is emphatically *not* intended |
| 12 | as a replacement or |
| 13 | competitor for IRC, Slack, Discord, Telegram, Google Hangouts, etc. |
| 14 | |
| 15 | * **Low administration** → |
| 16 | There is no additional set up or configuration. |
| 17 | Simply enable the [C capability](/setup_ucap_list) for users |
| 18 | whom you want to give access to the chatroom. |
| 19 | |
| 20 | * **Ephemeral** → |
| 21 | Chat messages do not sync to peer repositories. And they are |
| 22 | automatically deleted after a configurable delay (default: 7 days). |
| 23 | They can be deleted at any time without impacting any other part |
| 24 | of the system. |
| 25 | |
| 26 | Fossil chat is designed for use by insiders - people with check-in |
| 27 | privileges or higher. It is not intended as a general-purpose gathering |
| 28 | place for random passers-by on the internet. |
| 29 |
| --- www/chat.md | |
| +++ www/chat.md | |
| @@ -6,23 +6,26 @@ | |
| 6 | Fossil supports a developer chatroom feature. The chatroom provides an |
| 7 | ephemeral discussion venue for insiders. Design goals include: |
| 8 | |
| 9 | * **Simple but functional** → Fossil chat is designed to provide a |
| 10 | convenient real-time communication mechanism for geographically |
| 11 | dispersed developers. Fossil chat is *not* intended |
| 12 | as a replacement or |
| 13 | competitor for IRC, Slack, Discord, Telegram, Google Hangouts, etc. |
| 14 | |
| 15 | * **Low administration** → |
| 16 | You can activate the chatroom in seconds without having to |
| 17 | mess with configuration files or install new software. |
| 18 | In an existing [server setup](./server/), |
| 19 | simply enable the [C capability](/setup_ucap_list) for users |
| 20 | whom you want to give access to the chatroom. |
| 21 | |
| 22 | * **Ephemeral** → |
| 23 | Chat messages do not sync to peer repositories. And they are |
| 24 | automatically deleted after a configurable delay (default: 7 days). |
| 25 | Individual messages or the entire conversation |
| 26 | can be deleted at any time without impacting any other part |
| 27 | of the system. |
| 28 | |
| 29 | Fossil chat is designed for use by insiders - people with check-in |
| 30 | privileges or higher. It is not intended as a general-purpose gathering |
| 31 | place for random passers-by on the internet. |
| 32 |
+15
-14
| --- www/forum.wiki | ||
| +++ www/forum.wiki | ||
| @@ -12,19 +12,14 @@ | ||
| 12 | 12 | then turning on the forum feature |
| 13 | 13 | is just a matter of flipping some permission bits. There is |
| 14 | 14 | no new software to install and configure, and the same logins |
| 15 | 15 | and passwords work. |
| 16 | 16 | |
| 17 | - * <b>Malefactor Resistant:</b> Because Fossil accepts forum posts | |
| 18 | - only via the web UI, it is more resistent to spam. Passers-by | |
| 19 | - can post to the forum anonymously (subject to moderation), without | |
| 20 | - the hassle of a sign-up process. | |
| 21 | - | |
| 22 | - * <b>Distributed and Tamper-Proof:</b> Posts are stored in the Fossil | |
| 23 | - repository using the same [./fileformat.wiki | DAG/Merkle-tree design] | |
| 24 | - that Fossil uses to store your check-ins, wiki documents, etc. | |
| 25 | - Forum posts sync to cloned repositories. | |
| 17 | + * <b>Consistent Display:</b> Forum posts can be in [/md_rules|Markdown], | |
| 18 | + [/wiki_rules|Fossil Wiki], or plain text. Whichever format is used, the result is | |
| 19 | + displayed consistently across all platforms and operating systems and | |
| 20 | + between mobile devices and desktops. | |
| 26 | 21 | |
| 27 | 22 | * <b>Editable:</b> Forum posts can be amended after they are sent, |
| 28 | 23 | to fix typos or provide updates. The original posts are preserved |
| 29 | 24 | as part of the historical record, but only the amended posts are |
| 30 | 25 | displayed by default. |
| @@ -31,22 +26,28 @@ | ||
| 31 | 26 | |
| 32 | 27 | * <b>Built-in Full-Text Search:</b> Forum posts can be included in |
| 33 | 28 | the index used by the built-in Fossil search logic. |
| 34 | 29 | |
| 35 | 30 | * <b>Off-Line Access:</b> Because forum posts are synced along with |
| 36 | - all other artifacts, you can search the forum, or add new posts | |
| 37 | - to the forum, while off-line. | |
| 31 | + all other artifacts, you can search the forum, or add new posts, or | |
| 32 | + edit existing posts, all while off-line. | |
| 38 | 33 | |
| 39 | 34 | * <b>Automatically Cross-Referenced To Other Fossil Artifacts:</b> Because forum |
| 40 | 35 | posts are normal Fossil artifacts, you can link from them to |
| 41 | 36 | other Fossil artifacts (check-ins, wiki, tickets) and from those other |
| 42 | 37 | artifacts to forum posts. The reverse links are recognized and |
| 43 | 38 | displayed automatically on the receiver. |
| 44 | 39 | |
| 45 | - * <b>Consistent Display:</b> Forum posts can be in Markdown, | |
| 46 | - Fossil Wiki, or plain text. Whichever format is used, the result is | |
| 47 | - displayed consistently across all platforms, including mobile. | |
| 40 | + * <b>Malefactor Resistant:</b> Because Fossil accepts forum posts | |
| 41 | + only via the web UI, it is more resistent to spam. Passers-by | |
| 42 | + can post to the forum anonymously (subject to moderation), without | |
| 43 | + the hassle of a sign-up process. | |
| 44 | + | |
| 45 | + * <b>Distributed and Tamper-Proof:</b> Posts are stored in the Fossil | |
| 46 | + repository using the same [./fileformat.wiki | DAG/Merkle-tree design] | |
| 47 | + that Fossil uses to store your check-ins, wiki documents, etc. | |
| 48 | + Forum posts sync to cloned repositories. | |
| 48 | 49 | |
| 49 | 50 | <h2>Example Installations</h2> |
| 50 | 51 | |
| 51 | 52 | Both the [forum:/forum|Fossil project itself] and the |
| 52 | 53 | [https://sqlite.org/forum/forum|SQLite project] use the Fossil forum in place |
| 53 | 54 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -12,19 +12,14 @@ | |
| 12 | then turning on the forum feature |
| 13 | is just a matter of flipping some permission bits. There is |
| 14 | no new software to install and configure, and the same logins |
| 15 | and passwords work. |
| 16 | |
| 17 | * <b>Malefactor Resistant:</b> Because Fossil accepts forum posts |
| 18 | only via the web UI, it is more resistent to spam. Passers-by |
| 19 | can post to the forum anonymously (subject to moderation), without |
| 20 | the hassle of a sign-up process. |
| 21 | |
| 22 | * <b>Distributed and Tamper-Proof:</b> Posts are stored in the Fossil |
| 23 | repository using the same [./fileformat.wiki | DAG/Merkle-tree design] |
| 24 | that Fossil uses to store your check-ins, wiki documents, etc. |
| 25 | Forum posts sync to cloned repositories. |
| 26 | |
| 27 | * <b>Editable:</b> Forum posts can be amended after they are sent, |
| 28 | to fix typos or provide updates. The original posts are preserved |
| 29 | as part of the historical record, but only the amended posts are |
| 30 | displayed by default. |
| @@ -31,22 +26,28 @@ | |
| 31 | |
| 32 | * <b>Built-in Full-Text Search:</b> Forum posts can be included in |
| 33 | the index used by the built-in Fossil search logic. |
| 34 | |
| 35 | * <b>Off-Line Access:</b> Because forum posts are synced along with |
| 36 | all other artifacts, you can search the forum, or add new posts |
| 37 | to the forum, while off-line. |
| 38 | |
| 39 | * <b>Automatically Cross-Referenced To Other Fossil Artifacts:</b> Because forum |
| 40 | posts are normal Fossil artifacts, you can link from them to |
| 41 | other Fossil artifacts (check-ins, wiki, tickets) and from those other |
| 42 | artifacts to forum posts. The reverse links are recognized and |
| 43 | displayed automatically on the receiver. |
| 44 | |
| 45 | * <b>Consistent Display:</b> Forum posts can be in Markdown, |
| 46 | Fossil Wiki, or plain text. Whichever format is used, the result is |
| 47 | displayed consistently across all platforms, including mobile. |
| 48 | |
| 49 | <h2>Example Installations</h2> |
| 50 | |
| 51 | Both the [forum:/forum|Fossil project itself] and the |
| 52 | [https://sqlite.org/forum/forum|SQLite project] use the Fossil forum in place |
| 53 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -12,19 +12,14 @@ | |
| 12 | then turning on the forum feature |
| 13 | is just a matter of flipping some permission bits. There is |
| 14 | no new software to install and configure, and the same logins |
| 15 | and passwords work. |
| 16 | |
| 17 | * <b>Consistent Display:</b> Forum posts can be in [/md_rules|Markdown], |
| 18 | [/wiki_rules|Fossil Wiki], or plain text. Whichever format is used, the result is |
| 19 | displayed consistently across all platforms and operating systems and |
| 20 | between mobile devices and desktops. |
| 21 | |
| 22 | * <b>Editable:</b> Forum posts can be amended after they are sent, |
| 23 | to fix typos or provide updates. The original posts are preserved |
| 24 | as part of the historical record, but only the amended posts are |
| 25 | displayed by default. |
| @@ -31,22 +26,28 @@ | |
| 26 | |
| 27 | * <b>Built-in Full-Text Search:</b> Forum posts can be included in |
| 28 | the index used by the built-in Fossil search logic. |
| 29 | |
| 30 | * <b>Off-Line Access:</b> Because forum posts are synced along with |
| 31 | all other artifacts, you can search the forum, or add new posts, or |
| 32 | edit existing posts, all while off-line. |
| 33 | |
| 34 | * <b>Automatically Cross-Referenced To Other Fossil Artifacts:</b> Because forum |
| 35 | posts are normal Fossil artifacts, you can link from them to |
| 36 | other Fossil artifacts (check-ins, wiki, tickets) and from those other |
| 37 | artifacts to forum posts. The reverse links are recognized and |
| 38 | displayed automatically on the receiver. |
| 39 | |
| 40 | * <b>Malefactor Resistant:</b> Because Fossil accepts forum posts |
| 41 | only via the web UI, it is more resistent to spam. Passers-by |
| 42 | can post to the forum anonymously (subject to moderation), without |
| 43 | the hassle of a sign-up process. |
| 44 | |
| 45 | * <b>Distributed and Tamper-Proof:</b> Posts are stored in the Fossil |
| 46 | repository using the same [./fileformat.wiki | DAG/Merkle-tree design] |
| 47 | that Fossil uses to store your check-ins, wiki documents, etc. |
| 48 | Forum posts sync to cloned repositories. |
| 49 | |
| 50 | <h2>Example Installations</h2> |
| 51 | |
| 52 | Both the [forum:/forum|Fossil project itself] and the |
| 53 | [https://sqlite.org/forum/forum|SQLite project] use the Fossil forum in place |
| 54 |
+2
-1
| --- www/server/whyuseaserver.wiki | ||
| +++ www/server/whyuseaserver.wiki | ||
| @@ -14,11 +14,12 @@ | ||
| 14 | 14 | Here are a few reasons to set up a Fossil server for your project: |
| 15 | 15 | |
| 16 | 16 | 1. <b>A server works as a complete project website.</b><p> |
| 17 | 17 | Fossil does more than just version control. It also supports |
| 18 | 18 | [../tickets.wiki|trouble-tickets], |
| 19 | - [../wikitheory.wiki|wiki], and a [../forum.wiki|forum]. | |
| 19 | + [../wikitheory.wiki|wiki], | |
| 20 | + a [../chat.md|developer chat room], and a [../forum.wiki|forum]. | |
| 20 | 21 | The [../embeddeddoc.wiki|embedded documentation] |
| 21 | 22 | feature provides a great mechanism for providing project documentation. |
| 22 | 23 | The [../unvers.wiki|unversioned files] feature is a convenient way |
| 23 | 24 | to host builds and downloads on the project website. |
| 24 | 25 | |
| 25 | 26 |
| --- www/server/whyuseaserver.wiki | |
| +++ www/server/whyuseaserver.wiki | |
| @@ -14,11 +14,12 @@ | |
| 14 | Here are a few reasons to set up a Fossil server for your project: |
| 15 | |
| 16 | 1. <b>A server works as a complete project website.</b><p> |
| 17 | Fossil does more than just version control. It also supports |
| 18 | [../tickets.wiki|trouble-tickets], |
| 19 | [../wikitheory.wiki|wiki], and a [../forum.wiki|forum]. |
| 20 | The [../embeddeddoc.wiki|embedded documentation] |
| 21 | feature provides a great mechanism for providing project documentation. |
| 22 | The [../unvers.wiki|unversioned files] feature is a convenient way |
| 23 | to host builds and downloads on the project website. |
| 24 | |
| 25 |
| --- www/server/whyuseaserver.wiki | |
| +++ www/server/whyuseaserver.wiki | |
| @@ -14,11 +14,12 @@ | |
| 14 | Here are a few reasons to set up a Fossil server for your project: |
| 15 | |
| 16 | 1. <b>A server works as a complete project website.</b><p> |
| 17 | Fossil does more than just version control. It also supports |
| 18 | [../tickets.wiki|trouble-tickets], |
| 19 | [../wikitheory.wiki|wiki], |
| 20 | a [../chat.md|developer chat room], and a [../forum.wiki|forum]. |
| 21 | The [../embeddeddoc.wiki|embedded documentation] |
| 22 | feature provides a great mechanism for providing project documentation. |
| 23 | The [../unvers.wiki|unversioned files] feature is a convenient way |
| 24 | to host builds and downloads on the project website. |
| 25 | |
| 26 |