From 7ab869d5422b2b5b2e7619a770854f3d47814050 Mon Sep 17 00:00:00 2001 From: Eric Drechsel Date: Thu, 2 Jun 2016 18:59:20 -0700 Subject: [PATCH] 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 tag in /code replaced with Site index page has non-typographic elements, so converting to markdown seems pointless. Change-Id: I7b19337742f727f85e58639a1168cc46fd8a4e62 --- website/content/code.html | 45 -------------------- website/content/code.md | 76 ++++++++++++++++++++++++++++++++++ website/content/community.html | 17 -------- website/content/community.md | 20 +++++++++ website/content/download.html | 40 ------------------ website/content/download.md | 55 ++++++++++++++++++++++++ website/static/all.css | 4 -- 7 files changed, 151 insertions(+), 106 deletions(-) delete mode 100644 website/content/code.html create mode 100644 website/content/code.md delete mode 100644 website/content/community.html create mode 100644 website/content/community.md delete mode 100644 website/content/download.html create mode 100644 website/content/download.md diff --git a/website/content/code.html b/website/content/code.html deleted file mode 100644 index f509221cb..000000000 --- a/website/content/code.html +++ /dev/null @@ -1,45 +0,0 @@ -

Get the code

- -
$ git clone https://camlistore.googlesource.com/camlistore
- - - -

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. The client, search and schema packages are also a good place to start.

- -

Contributing to Camlistore

- -
    -
  • Join the mailing list.
    • -
  • Pick something that interests you, or look through our list of potential projects 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: - - 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/.
    • -
  • Usual Work Flow
    • -
      -
    • Create a topic branch, make some changes and commit away.
      • -
    • Read CONTRIBUTING. 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)
      • -
    -
diff --git a/website/content/code.md b/website/content/code.md new file mode 100644 index 000000000..880959aa2 --- /dev/null +++ b/website/content/code.md @@ -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)) diff --git a/website/content/community.html b/website/content/community.html deleted file mode 100644 index 3abaecd5c..000000000 --- a/website/content/community.html +++ /dev/null @@ -1,17 +0,0 @@ -

Community

- -

Camlistore survives with the generous contributions of time and code by our contributors. If you'd like to contribute, find out how to get the code and how to start submitting changes.

- - diff --git a/website/content/community.md b/website/content/community.md new file mode 100644 index 000000000..a0cfcf2ee --- /dev/null +++ b/website/content/community.md @@ -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 diff --git a/website/content/download.html b/website/content/download.html deleted file mode 100644 index 6d778163e..000000000 --- a/website/content/download.html +++ /dev/null @@ -1,40 +0,0 @@ -

Download Camlistore

- -

The latest release is 0.9 ("Astrakhan").

- -

Or, the canonical git repo is:

-
$ git clone https://camlistore.googlesource.com/camlistore
- -

Download and install Go if you don't have that installed already. As of revision 33a8eec, Camlistore requires Go 1.6 or newer.

- -

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 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.

- -

Release Notes

-

Previous release notes:

- - diff --git a/website/content/download.md b/website/content/download.md new file mode 100644 index 000000000..42a276d19 --- /dev/null +++ b/website/content/download.md @@ -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 diff --git a/website/static/all.css b/website/static/all.css index 303500f67..a0d908dc7 100644 --- a/website/static/all.css +++ b/website/static/all.css @@ -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;