Rooba
/
perkeep
mirror of https://github.com/perkeep/perkeep.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Convert code, community, and download pages to md. 

Output differences:

 - Changed the heading "Contributing to Camlistore" to just
   "Contributing", so the heading ID stays the same.
 - Remove "ul.lispaced" class, just put newlines
   between list items instead (visually identical)
 - One instance of obsolete <tt> tag in /code replaced with <code>

Site index page has non-typographic elements, so converting to markdown
seems pointless.

Change-Id: I7b19337742f727f85e58639a1168cc46fd8a4e62
This commit is contained in:
Eric Drechsel 2016-06-02 18:59:20 -07:00
parent 80f011484a
commit 7ab869d542
7 changed files with 151 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
website/content/code.html
View File

@ -1,45 +0,0 @@
<h1>Get the code</h1>
<pre>$ git clone https://camlistore.googlesource.com/camlistore</pre>
<ul>
<li><a href="https://camlistore.googlesource.com/camlistore">Latest changes</a></li>
<li><a href="https://camlistore.googlesource.com/camlistore/+/master">Browse tree</a></li>
<li><a href="https://camlistore-review.googlesource.com/">Code Review</a></li>
</ul>
<h2>Making apps that work with Camlistore</h2>
<p>Camlistore is built so that other apps can securely access and store data without running alongside it. Camlistore is the perfect backing store for other web apps and CMSes.</p>
<p>Detailed documention on the HTTP blob retrieval protocol can be found at <a href="/doc/protocol">the protocol documentation</a>. The <a href="/pkg/client">client</a>, <a href="/pkg/search">search</a> and <a href="/pkg/schema">schema</a> packages are also a good place to start.</p>
<h2 id="contributing">Contributing to Camlistore</h2>
<ul class='lispaced'>
<li>Join the <a href="https://groups.google.com/group/camlistore">mailing list</a>.</li>
<li>Pick something that interests you, or look through our list of <a href="/doc/todo">potential projects</a> for inspiration. <strong>Discuss it first</strong>, especially if it's large and/or not well designed yet. You'll save yourself a headache if someone is already working on something similar or if there's a more Camlistore-like approach to the issue.</li>
<li>Submit your changes through the review process discussed below.</li>
<li>Note that you'll need to agree to the appropriate Contributor License Agreement:
<ul>
<li><a href="https://developers.google.com/open-source/cla/individual">Individual Contributor License Agreement</a></li>
<li><a href="https://developers.google.com/open-source/cla/corporate">Corporate Contributor License Agreement</a></li>
</ul>
These make lawyers feel all warm and cozy about open source. Be sure to <b>email Brad or the list</b> when you've submitted one so it can be processed and you'll be added to the CONTRIBUTORS file so your patches can be reviewed and submitted.
</li>
</ul>
<h3>Code Review</h3>
<ul class='lispaced'>
<li>Camlistore requires changes to be reviewed before they are committed.</li>
<li>Update your <tt>~/.netrc</tt> file with a Gerrit username and password. Click the <strong>"Generate a new password"</strong> link from the top of <a href="https://camlistore.googlesource.com/">https://camlistore.googlesource.com/</a>.</li>
<li>Usual Work Flow</li>
<ul>
<li>Create a topic branch, make some changes and commit away.</li>
<li>Read <a href="https://camlistore.googlesource.com/camlistore/+/master/CONTRIBUTING.md">CONTRIBUTING</a>. Install devcam.</li>
<li>Test. (<code>devcam test</code>). </li>
<li>Squash your changes into a single change, and compose a proper commit message.</li>
<li>Send for review with: <pre>devcam review</pre></li>
<li>Modify as necessary until change is merged. Amend your commit or squash to a single commit before sending for review again (be sure to keep the same <a href="http://gerrit.googlecode.com/svn/documentation/2.2.1/user-changeid.html">the Change-Id line</a>)</li>
</ul>
</ul>

76
website/content/code.md Normal file
View File

@ -0,0 +1,76 @@
# Get the code
$ git clone https://camlistore.googlesource.com/camlistore
- [Latest changes](https://camlistore.googlesource.com/camlistore)
- [Browse
tree](https://camlistore.googlesource.com/camlistore/+/master)
- [Code Review](https://camlistore-review.googlesource.com/)
## Making apps that work with Camlistore
Camlistore is built so that other apps can securely access and store
data without running alongside it. Camlistore is the perfect backing
store for other web apps and CMSes.
Detailed documention on the HTTP blob retrieval protocol can be found at
[the protocol documentation](/doc/protocol). The [client](/pkg/client),
[search](/pkg/search) and [schema](/pkg/schema) packages are also a good
place to start.
## Contributing
- Join the [mailing list](https://groups.google.com/group/camlistore).
- Pick something that interests you, or look through our list of
[potential projects](/doc/todo) for inspiration. **Discuss it
first**, especially if it's large and/or not well designed yet.
You'll save yourself a headache if someone is already working on
something similar or if there's a more Camlistore-like approach to
the issue.
- Submit your changes through the review process discussed below.
- Note that you'll need to agree to the appropriate Contributor
License Agreement:
- [Individual Contributor License
Agreement](https://developers.google.com/open-source/cla/individual)
- [Corporate Contributor License
Agreement](https://developers.google.com/open-source/cla/corporate)
These make lawyers feel all warm and cozy about open source. Be sure
to **email Brad or the list** when you've submitted one so it can be
processed and you'll be added to the CONTRIBUTORS file so your
patches can be reviewed and submitted.
### Code Review
- Camlistore requires changes to be reviewed before they are
committed.
- Update your `~/.netrc` file with a Gerrit username and password.
Click the **"Generate a new password"** link from the top of
[https://camlistore.googlesource.com/](https://camlistore.googlesource.com/).
- Usual Work Flow
- Create a topic branch, make some changes and commit away.
- Read
[CONTRIBUTING](https://camlistore.googlesource.com/camlistore/+/master/CONTRIBUTING.md).
Install devcam.
- Test. (`devcam test`).
- Squash your changes into a single change, and compose a proper
commit message.
- Send for review with:
devcam review
- Modify as necessary until change is merged. Amend your commit or
squash to a single commit before sending for review again (be
sure to keep the same [the Change-Id
line](http://gerrit.googlecode.com/svn/documentation/2.2.1/user-changeid.html))

17
website/content/community.html
View File

@ -1,17 +0,0 @@
<h1>Community</h1>
<p>Camlistore survives with the generous contributions of time and code by our <a href="/contributors">contributors</a>. If you'd like to contribute, find out how to <a href="/code">get the code and how to start submitting changes</a>.</p>
<ul>
<li><a href="https://twitter.com/camlistore"><b>@camlistore</b></a>: Camlistore on Twitter</li>
<li>
<a href="https://groups.google.com/group/camlistore"><b>camlistore</b></a>: Mailing list for official discussion, design, help
</li>
<li>
<a href="https://groups.google.com/group/camlistore-commits"><b>camlistore-commits</b></a>: Mailing list for commit emails, code reviews
</li>
<li><a href="https://camlistore-review.googlesource.com/"><b>Gerrit</b></a>: Code review</li>
<li><a href="https://github.com/camlistore/camlistore"><b>Github</b></a>: our Github home (issues + source mirror)</li>
<li><a href="https://github.com/camlistore/camlistore/issues"><b>Issues</b></a>: Issue/bug tracker</li>
<li><a href="irc://chat.freenode.net/camlistore"><b>#camlistore</b></a>: Camlistore on Freenode IRC</li>
</ul>

20
website/content/community.md Normal file
View File

@ -0,0 +1,20 @@
# Community
Camlistore survives with the generous contributions of time and code by
our [contributors](/contributors). If you'd like to contribute, find out
how to [get the code and how to start submitting changes](/code).
- [**@camlistore**](https://twitter.com/camlistore): Camlistore on
Twitter
- [**camlistore**](https://groups.google.com/group/camlistore):
Mailing list for official discussion, design, help
- [**camlistore-commits**](https://groups.google.com/group/camlistore-commits):
Mailing list for commit emails, code reviews
- [**Gerrit**](https://camlistore-review.googlesource.com/): Code
review
- [**Github**](https://github.com/camlistore/camlistore): our Github
home (issues + source mirror)
- [**Issues**](https://github.com/camlistore/camlistore/issues):
Issue/bug tracker
- [**\#camlistore**](irc://chat.freenode.net/camlistore): Camlistore
on Freenode IRC

40
website/content/download.html
View File

@ -1,40 +0,0 @@
<h1>Download Camlistore</h1>
<p>The latest release is <a href="/doc/release/0.9">0.9 ("Astrakhan")</a>.</p>
<p>Or, the canonical git repo is:</p>
<pre>$ git clone https://camlistore.googlesource.com/camlistore</pre>
<p><a href="http://golang.org/doc/install">Download and install Go</a> if you don't have that installed already. As of revision <a href="https://github.com/camlistore/camlistore/commit/33a8eec553cc79fc31fbb076790100297f32d70b">33a8eec</a>, Camlistore requires <a href="https://golang.org/dl/">Go 1.6 or newer</a>.</p>
<p>Build Camlistore by running this command in the folder you downloaded or checked out:</p>
<pre>$ go run make.go</pre>
<p>Eventually we'll distribute binary releases, but for now you should build it yourself.</p>
<h2>Getting started</h2>
<p>Once you've successfully built the Camlistore components, you can run the server with:</p>
<pre>$ ./bin/camlistored</pre>
<p>This will create <a href="/doc/server-config">configuration</a> and public/private key information in <code>$HOME/.config/camlistore/</code> (or where <code>camtool env configdir</code> points). You can start and stop camlistored as you see fit.</p>
<p>You're done setting up! Running camlistored should open a new browser window pointed at your camlistore where you can start uploading and interacting with data.</p>
<p>Developers typically use the <code>./bin/devcam</code> wrapper to isolate their test environment from their production instance and to simplify common development tasks. If you have questions, you can ask the <a href="https://groups.google.com/group/camlistore">mailing list</a>.</p>
<h2>Release Notes</h2>
<p>Previous release notes:</p>
<ul>
<li><a href="/doc/release/0.9">0.9 ("Astrakhan")</a>, 2015-12-30</li>
<li><a href="/doc/release/0.8">0.8 ("Tokyo")</a>, 2014-08-03</li>
<li><a href="/doc/release/0.7">0.7 ("Brussels")</a>, 2014-02-27</li>
<li><a href="/doc/release/0.6">0.6 ("Cannon Beach")</a>, 2013-12-25</li>
<li><a href="/doc/release/0.5">0.5 ("Castletownbere")</a>, 2013-09-21</li>
<li><a href="/doc/release/0.4">0.4 ("Oyens")</a>, 2013-08-26</li>
<li><a href="/doc/release/0.3">0.3 ("Glebe")</a>, 2013-07-28</li>
<li><a href="/doc/release/0.2">0.2 ("Portland")</a>, 2013-06-22</li>
<li><a href="/doc/release/0.1">0.1 ("Grenoble")</a>, 2013-06-11</li>
</ul>

55
website/content/download.md Normal file
View File

@ -0,0 +1,55 @@
# Download Camlistore
The latest release is [0.9 ("Astrakhan")](/doc/release/0.9).
Or, the canonical git repo is:
$ git clone https://camlistore.googlesource.com/camlistore
[Download and install Go](http://golang.org/doc/install) if you don't
have that installed already. As of revision
[33a8eec](https://github.com/camlistore/camlistore/commit/33a8eec553cc79fc31fbb076790100297f32d70b),
Camlistore requires [Go 1.6 or newer](https://golang.org/dl/).
Build Camlistore by running this command in the folder you downloaded or
checked out:
$ go run make.go
Eventually we'll distribute binary releases, but for now you should
build it yourself.
## Getting started
Once you've successfully built the Camlistore components, you can run
the server with:
$ ./bin/camlistored
This will create [configuration](/doc/server-config) and public/private
key information in `$HOME/.config/camlistore/` (or where
`camtool env configdir` points). You can start and stop camlistored as
you see fit.
You're done setting up! Running camlistored should open a new browser
window pointed at your camlistore where you can start uploading and
interacting with data.
Developers typically use the `./bin/devcam` wrapper to isolate their
test environment from their production instance and to simplify common
development tasks. If you have questions, you can ask the [mailing
list](https://groups.google.com/group/camlistore).
## Release Notes
Previous release notes:
- [0.9 ("Astrakhan")](/doc/release/0.9), 2015-12-30
- [0.8 ("Tokyo")](/doc/release/0.8), 2014-08-03
- [0.7 ("Brussels")](/doc/release/0.7), 2014-02-27
- [0.6 ("Cannon Beach")](/doc/release/0.6), 2013-12-25
- [0.5 ("Castletownbere")](/doc/release/0.5), 2013-09-21
- [0.4 ("Oyens")](/doc/release/0.4), 2013-08-26
- [0.3 ("Glebe")](/doc/release/0.3), 2013-07-28
- [0.2 ("Portland")](/doc/release/0.2), 2013-06-22
- [0.1 ("Grenoble")](/doc/release/0.1), 2013-06-11

4
website/static/all.css
View File

@ -228,10 +228,6 @@ dl.terms dt {
font-style: italic;
}
ul.lispaced li {
margin-top: 0.8em;
}
pre.sty {
padding-left: 1em;
border-left: 2px solid #e84c00;