Fossil SCM
Add documentation (advocacy-type documentation) on the fossil web interface. Created links from the homepage.
Commit
5c65487c5f5cfc8970a4fdd8ad6b2d400faefe7c
Parent
627de3bf16b0552…
3 files changed
+15
-3
+6
-7
+18
+15
-3
| --- www/embeddeddoc.wiki | ||
| +++ www/embeddeddoc.wiki | ||
| @@ -1,6 +1,6 @@ | ||
| 1 | -<h1>Managing Project Documentation</h1> | |
| 1 | +<h1 align="center">Managing Project Documentation</h1> | |
| 2 | 2 | |
| 3 | 3 | Fossil provides a built-in <a href="wikitheory.wiki">wiki</a> |
| 4 | 4 | that can be used to store the |
| 5 | 5 | documentation for a project. This is sufficient for many projects. |
| 6 | 6 | If your project is well-served by wiki documentation, then you |
| @@ -99,17 +99,29 @@ | ||
| 99 | 99 | This is one of three ways to set up a |
| 100 | 100 | <a href="quickstart.wiki#serversetup">fossil web server</a>. |
| 101 | 101 | |
| 102 | 102 | The "<b>/tip/</b>" part of the URL tells fossil to use |
| 103 | 103 | the documentation files from the check-in that was checked in most |
| 104 | -recently. This file is stored in the fossil source tree under | |
| 104 | +recently. If you wanted to see an historical version of this document, | |
| 105 | +you could substitute the name of a check-in for "<b>/tip/</b>". | |
| 106 | +For example, to see the version of this document associated with | |
| 107 | +check-in [9be1b00392], simply replace the "<b>/tip/</b>" with | |
| 108 | +"<b>/9be1b00392/</b>". You can also substitute the symbolic name | |
| 109 | +for a particular version or branch. For example, you might | |
| 110 | +replace "<b>/tip/</b>" with "<b>/trunk/</b>" to get the latest | |
| 111 | +version of this document in the "trunk" branch. (As of this writing, | |
| 112 | +the self-hosting fossil repository only has a single branch "trunk" and | |
| 113 | +so "trunk" and "tip" amount to the same thing, but they would be different | |
| 114 | +in a project with multiple branches.) | |
| 115 | + | |
| 116 | +The file that encodes this document is stored in the fossil source tree under | |
| 105 | 117 | the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the |
| 106 | -last part of the URL. | |
| 118 | +last part of the URL for this document. | |
| 107 | 119 | |
| 108 | 120 | As I sit writing this documentation file, I am testing my work by |
| 109 | 121 | running the "<b>fossil server</b>" command line and viewing |
| 110 | 122 | <b>http://localhost:8080/doc/ckout/www/embeddeddoc.wiki</b> in |
| 111 | 123 | Firefox. I am doing this even though I have not yet checked in |
| 112 | 124 | the "<b>www/embeddeddoc.wiki</b>" file for the first time. Using |
| 113 | 125 | the special "<b>ckout</b>" version identifier on the "<b>/doc</b>" page |
| 114 | 126 | it is easy to make multiple changes to multiple files and see how they all |
| 115 | 127 | look together before committing anything to the repository. |
| 116 | 128 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -1,6 +1,6 @@ | |
| 1 | <h1>Managing Project Documentation</h1> |
| 2 | |
| 3 | Fossil provides a built-in <a href="wikitheory.wiki">wiki</a> |
| 4 | that can be used to store the |
| 5 | documentation for a project. This is sufficient for many projects. |
| 6 | If your project is well-served by wiki documentation, then you |
| @@ -99,17 +99,29 @@ | |
| 99 | This is one of three ways to set up a |
| 100 | <a href="quickstart.wiki#serversetup">fossil web server</a>. |
| 101 | |
| 102 | The "<b>/tip/</b>" part of the URL tells fossil to use |
| 103 | the documentation files from the check-in that was checked in most |
| 104 | recently. This file is stored in the fossil source tree under |
| 105 | the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the |
| 106 | last part of the URL. |
| 107 | |
| 108 | As I sit writing this documentation file, I am testing my work by |
| 109 | running the "<b>fossil server</b>" command line and viewing |
| 110 | <b>http://localhost:8080/doc/ckout/www/embeddeddoc.wiki</b> in |
| 111 | Firefox. I am doing this even though I have not yet checked in |
| 112 | the "<b>www/embeddeddoc.wiki</b>" file for the first time. Using |
| 113 | the special "<b>ckout</b>" version identifier on the "<b>/doc</b>" page |
| 114 | it is easy to make multiple changes to multiple files and see how they all |
| 115 | look together before committing anything to the repository. |
| 116 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -1,6 +1,6 @@ | |
| 1 | <h1 align="center">Managing Project Documentation</h1> |
| 2 | |
| 3 | Fossil provides a built-in <a href="wikitheory.wiki">wiki</a> |
| 4 | that can be used to store the |
| 5 | documentation for a project. This is sufficient for many projects. |
| 6 | If your project is well-served by wiki documentation, then you |
| @@ -99,17 +99,29 @@ | |
| 99 | This is one of three ways to set up a |
| 100 | <a href="quickstart.wiki#serversetup">fossil web server</a>. |
| 101 | |
| 102 | The "<b>/tip/</b>" part of the URL tells fossil to use |
| 103 | the documentation files from the check-in that was checked in most |
| 104 | recently. If you wanted to see an historical version of this document, |
| 105 | you could substitute the name of a check-in for "<b>/tip/</b>". |
| 106 | For example, to see the version of this document associated with |
| 107 | check-in [9be1b00392], simply replace the "<b>/tip/</b>" with |
| 108 | "<b>/9be1b00392/</b>". You can also substitute the symbolic name |
| 109 | for a particular version or branch. For example, you might |
| 110 | replace "<b>/tip/</b>" with "<b>/trunk/</b>" to get the latest |
| 111 | version of this document in the "trunk" branch. (As of this writing, |
| 112 | the self-hosting fossil repository only has a single branch "trunk" and |
| 113 | so "trunk" and "tip" amount to the same thing, but they would be different |
| 114 | in a project with multiple branches.) |
| 115 | |
| 116 | The file that encodes this document is stored in the fossil source tree under |
| 117 | the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the |
| 118 | last part of the URL for this document. |
| 119 | |
| 120 | As I sit writing this documentation file, I am testing my work by |
| 121 | running the "<b>fossil server</b>" command line and viewing |
| 122 | <b>http://localhost:8080/doc/ckout/www/embeddeddoc.wiki</b> in |
| 123 | Firefox. I am doing this even though I have not yet checked in |
| 124 | the "<b>www/embeddeddoc.wiki</b>" file for the first time. Using |
| 125 | the special "<b>ckout</b>" version identifier on the "<b>/doc</b>" page |
| 126 | it is easy to make multiple changes to multiple files and see how they all |
| 127 | look together before committing anything to the repository. |
| 128 |
+6
-7
| --- www/index.wiki | ||
| +++ www/index.wiki | ||
| @@ -28,14 +28,13 @@ | ||
| 28 | 28 | <a href="http://subversion.tigris.org/">subversion</a>, |
| 29 | 29 | <li>Or, operations on local repositories, |
| 30 | 30 | <li>Or, all of the above at the same time</ul> |
| 31 | 31 | * Integrated, [./bugtheory.wiki | distributed bug tracking] and |
| 32 | 32 | [./wikitheory.wiki | distributed wiki]. |
| 33 | - * Built-in web interface that supports deep archaeological digs through | |
| 34 | - the project history. | |
| 35 | - * All network communication via | |
| 36 | - [http://en.wikipedia.org/wiki/HTTP | HTTP] with | |
| 33 | + * Built-in [./webui.wiki | web interface] that supports deep | |
| 34 | + archaeological digs through the project history. | |
| 35 | + * All network communication via HTTP with | |
| 37 | 36 | [./quickstart.wiki#proxy | proxy support] |
| 38 | 37 | so that everything works from behind restrictive firewalls. |
| 39 | 38 | * Everything (client, server, and utilities) is included in a |
| 40 | 39 | single self-contained executable - trivial to install |
| 41 | 40 | * Server runs as [./quickstart.wiki#cgiserver | CGI], using |
| @@ -55,12 +54,14 @@ | ||
| 55 | 54 | |
| 56 | 55 | <b>User Links:</b> |
| 57 | 56 | |
| 58 | 57 | * [./faq.wiki | FAQ] |
| 59 | 58 | * The [./concepts.wiki | concepts] behind fossil |
| 60 | - * [./build.wiki | Building And Installing] | |
| 61 | 59 | * [./quickstart.wiki | Quick Start] guide to using fossil |
| 60 | + * [./reviews.wiki | Testimonials] from fossil users. | |
| 61 | + * [./qandc.wiki | Questions & Criticisms] directed at fossil. | |
| 62 | + * [./build.wiki | Building And Installing] | |
| 62 | 63 | * Fossil supports [./embeddeddoc.wiki | embedded documentation] |
| 63 | 64 | that is versioned along with project source code. |
| 64 | 65 | * A tutorial on [./branching.wiki | branching], what it means and how |
| 65 | 66 | to do it using fossil. |
| 66 | 67 | * The [./selfcheck.wiki | automatic self-check] mechanism |
| @@ -67,12 +68,10 @@ | ||
| 67 | 68 | helps insure project integrity. |
| 68 | 69 | * Fossil contains a [./wikitheory.wiki | built-in wiki]. |
| 69 | 70 | * There is a |
| 70 | 71 | [http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users | mailing list] |
| 71 | 72 | available for discussing fossil issues. |
| 72 | - * [./qandc.wiki | Questions & Criticisms] directed at fossil. | |
| 73 | - * [./reviews.wiki | Testimonials] from fossil users. | |
| 74 | 73 | * Some (unfinished but expanding) extended |
| 75 | 74 | [./reference.wiki | reference documentation] for the fossil command line. |
| 76 | 75 | |
| 77 | 76 | <b>Developer Links:</b> |
| 78 | 77 | |
| 79 | 78 | |
| 80 | 79 | ADDED www/webui.wiki |
| --- www/index.wiki | |
| +++ www/index.wiki | |
| @@ -28,14 +28,13 @@ | |
| 28 | <a href="http://subversion.tigris.org/">subversion</a>, |
| 29 | <li>Or, operations on local repositories, |
| 30 | <li>Or, all of the above at the same time</ul> |
| 31 | * Integrated, [./bugtheory.wiki | distributed bug tracking] and |
| 32 | [./wikitheory.wiki | distributed wiki]. |
| 33 | * Built-in web interface that supports deep archaeological digs through |
| 34 | the project history. |
| 35 | * All network communication via |
| 36 | [http://en.wikipedia.org/wiki/HTTP | HTTP] with |
| 37 | [./quickstart.wiki#proxy | proxy support] |
| 38 | so that everything works from behind restrictive firewalls. |
| 39 | * Everything (client, server, and utilities) is included in a |
| 40 | single self-contained executable - trivial to install |
| 41 | * Server runs as [./quickstart.wiki#cgiserver | CGI], using |
| @@ -55,12 +54,14 @@ | |
| 55 | |
| 56 | <b>User Links:</b> |
| 57 | |
| 58 | * [./faq.wiki | FAQ] |
| 59 | * The [./concepts.wiki | concepts] behind fossil |
| 60 | * [./build.wiki | Building And Installing] |
| 61 | * [./quickstart.wiki | Quick Start] guide to using fossil |
| 62 | * Fossil supports [./embeddeddoc.wiki | embedded documentation] |
| 63 | that is versioned along with project source code. |
| 64 | * A tutorial on [./branching.wiki | branching], what it means and how |
| 65 | to do it using fossil. |
| 66 | * The [./selfcheck.wiki | automatic self-check] mechanism |
| @@ -67,12 +68,10 @@ | |
| 67 | helps insure project integrity. |
| 68 | * Fossil contains a [./wikitheory.wiki | built-in wiki]. |
| 69 | * There is a |
| 70 | [http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users | mailing list] |
| 71 | available for discussing fossil issues. |
| 72 | * [./qandc.wiki | Questions & Criticisms] directed at fossil. |
| 73 | * [./reviews.wiki | Testimonials] from fossil users. |
| 74 | * Some (unfinished but expanding) extended |
| 75 | [./reference.wiki | reference documentation] for the fossil command line. |
| 76 | |
| 77 | <b>Developer Links:</b> |
| 78 | |
| 79 | |
| 80 | DDED www/webui.wiki |
| --- www/index.wiki | |
| +++ www/index.wiki | |
| @@ -28,14 +28,13 @@ | |
| 28 | <a href="http://subversion.tigris.org/">subversion</a>, |
| 29 | <li>Or, operations on local repositories, |
| 30 | <li>Or, all of the above at the same time</ul> |
| 31 | * Integrated, [./bugtheory.wiki | distributed bug tracking] and |
| 32 | [./wikitheory.wiki | distributed wiki]. |
| 33 | * Built-in [./webui.wiki | web interface] that supports deep |
| 34 | archaeological digs through the project history. |
| 35 | * All network communication via HTTP with |
| 36 | [./quickstart.wiki#proxy | proxy support] |
| 37 | so that everything works from behind restrictive firewalls. |
| 38 | * Everything (client, server, and utilities) is included in a |
| 39 | single self-contained executable - trivial to install |
| 40 | * Server runs as [./quickstart.wiki#cgiserver | CGI], using |
| @@ -55,12 +54,14 @@ | |
| 54 | |
| 55 | <b>User Links:</b> |
| 56 | |
| 57 | * [./faq.wiki | FAQ] |
| 58 | * The [./concepts.wiki | concepts] behind fossil |
| 59 | * [./quickstart.wiki | Quick Start] guide to using fossil |
| 60 | * [./reviews.wiki | Testimonials] from fossil users. |
| 61 | * [./qandc.wiki | Questions & Criticisms] directed at fossil. |
| 62 | * [./build.wiki | Building And Installing] |
| 63 | * Fossil supports [./embeddeddoc.wiki | embedded documentation] |
| 64 | that is versioned along with project source code. |
| 65 | * A tutorial on [./branching.wiki | branching], what it means and how |
| 66 | to do it using fossil. |
| 67 | * The [./selfcheck.wiki | automatic self-check] mechanism |
| @@ -67,12 +68,10 @@ | |
| 68 | helps insure project integrity. |
| 69 | * Fossil contains a [./wikitheory.wiki | built-in wiki]. |
| 70 | * There is a |
| 71 | [http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users | mailing list] |
| 72 | available for discussing fossil issues. |
| 73 | * Some (unfinished but expanding) extended |
| 74 | [./reference.wiki | reference documentation] for the fossil command line. |
| 75 | |
| 76 | <b>Developer Links:</b> |
| 77 | |
| 78 | |
| 79 | DDED www/webui.wiki |
+18
| --- a/www/webui.wiki | ||
| +++ b/www/webui.wiki | ||
| @@ -0,0 +1,18 @@ | ||
| 1 | +<h1 align="center"pt for <h2>Overview</h2r thh1r the | |
| 2 | +[httf | |
| 3 | + Status information | |
| 4 | + * Timelineswins | |
| 5 | + * Move check" linksBlogs, News, and Announcement. JYou don't have a Links to dfffprecompiled binarystock fNote also that because ffffffand ticket/bug-report changor ticket changeleaves and Leaves" or "Branchesffff | |
| 6 | +Once you have your newdelete | |
| 7 | +the original repository from your local machine, then clone the repository | |
| 8 | +off of the server: | |
| 9 | + | |
| 10 | + <b>fossil clone http://user:[email protected]/cgi-bin/my-project</b> | |
| 11 | + | |
| 12 | +(As always, adjust the URL as appropriate for your installation.) | |
| 13 | +After copying a repository, it is important to reclone it onto new machines. | |
| 14 | +Each repository has a random "repository ID" and repositories will not | |
| 15 | +sync with another repository having the same ID (to avoid sync loops). | |
| 16 | +Cloning the repository will give you a new repository ID in your local | |
| 17 | +copy and allow you to sync with the server. | |
| 18 | +ha |
| --- a/www/webui.wiki | |
| +++ b/www/webui.wiki | |
| @@ -0,0 +1,18 @@ | |
| --- a/www/webui.wiki | |
| +++ b/www/webui.wiki | |
| @@ -0,0 +1,18 @@ | |
| 1 | <h1 align="center"pt for <h2>Overview</h2r thh1r the |
| 2 | [httf |
| 3 | Status information |
| 4 | * Timelineswins |
| 5 | * Move check" linksBlogs, News, and Announcement. JYou don't have a Links to dfffprecompiled binarystock fNote also that because ffffffand ticket/bug-report changor ticket changeleaves and Leaves" or "Branchesffff |
| 6 | Once you have your newdelete |
| 7 | the original repository from your local machine, then clone the repository |
| 8 | off of the server: |
| 9 | |
| 10 | <b>fossil clone http://user:[email protected]/cgi-bin/my-project</b> |
| 11 | |
| 12 | (As always, adjust the URL as appropriate for your installation.) |
| 13 | After copying a repository, it is important to reclone it onto new machines. |
| 14 | Each repository has a random "repository ID" and repositories will not |
| 15 | sync with another repository having the same ID (to avoid sync loops). |
| 16 | Cloning the repository will give you a new repository ID in your local |
| 17 | copy and allow you to sync with the server. |
| 18 | ha |