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

70 lines
3.8 KiB
Markdown
Raw Permalink Normal View History

website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
# Documentation
docs dir
2011-01-28 07:48:31 +00:00
website: fix remaining old links to /docs/ interestingly, I also discovered that GitHub will properly resolve links that are relative to the root path (e.g. "/doc/foo")... it properly rewrites these links to reference the named file relative to the repository root. also add a /doc/contributing.md file. This will never be served from the website, since we have a redirect handler in place, but is added so that we don't have broken links when browsing the docs on GitHub. Change-Id: I47517a5f6303065df02ac11771dcee56cd06a4b7
2016-05-02 05:20:16 +00:00
* [Overview](/doc/overview.md): The original motivation and background for why
website: first pass of s/Camlistore/Perkeep/ on contents A second pass will be needed on the URLs once we have moved all the repos and such. Issue #981 Change-Id: Ibb58f4c4f16481da69e811142e8337b826c0d164
2017-12-15 17:57:42 +00:00
Perkeep exists and what one might use it for.
doc: add comparison to other software and services Change-Id: I45f228abd4ca7f970e433e5254428dd48fe596fc
2018-01-09 16:25:17 +00:00
* [Compare](/doc/compare.md): how Perkeep compares to similar services and software
Start of server-config docs. Fix some links. Change-Id: I8aa88bc9ed603b16bad8e00a41649f30e4bbb642
2013-06-11 13:50:55 +00:00
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
## For Users
Initial changes to the website Give a better sense of what camlistore is right away More readable headings on those yellow bars Reduce number of items in the nav Add detail to download and getting started section Turned mailing list page into community page Style changes to the front page from aaron. Reworked the code page Added some pages to fill in, protocol and todo Reorganized docs page Redirect lists to new community page Change-Id: I4e953e53618b93420f9f57aaf48d2d3651977b57
2014-02-06 22:14:19 +00:00
website: first pass of s/Camlistore/Perkeep/ on contents A second pass will be needed on the URLs once we have moved all the repos and such. Issue #981 Change-Id: Ibb58f4c4f16481da69e811142e8337b826c0d164
2017-12-15 17:57:42 +00:00
**If you're just looking to set up a Perkeep server and use it yourself,
doc: fix link that doesn't link properly on GitHub Managing our links between GitHub, Gerrit, and the website's rendering of the same Markdown continues to be a disaster. Fixes #1128 Updates #1146 Change-Id: I8645c6fee4bf5271ca4fc08acb69c53785a36182
2018-05-03 04:31:46 +00:00
check out our [getting started guide](https://perkeep.org/download#getting-started).**
The documents below go into more detail on customizing the high level
configuration for use such as alternative blob storage or
synchronization to cloud storage.
Start of server-config docs. Fix some links. Change-Id: I8aa88bc9ed603b16bad8e00a41649f30e4bbb642
2013-06-11 13:50:55 +00:00
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
* [Command-line tools](/cmd/)
website: fix remaining old links to /docs/ interestingly, I also discovered that GitHub will properly resolve links that are relative to the root path (e.g. "/doc/foo")... it properly rewrites these links to reference the named file relative to the repository root. also add a /doc/contributing.md file. This will never be served from the website, since we have a redirect handler in place, but is added so that we don't have broken links when browsing the docs on GitHub. Change-Id: I47517a5f6303065df02ac11771dcee56cd06a4b7
2016-05-02 05:20:16 +00:00
* [Server Config](/doc/server-config.md): Details for configuring server storage
website: first pass of s/Camlistore/Perkeep/ on contents A second pass will be needed on the URLs once we have moved all the repos and such. Issue #981 Change-Id: Ibb58f4c4f16481da69e811142e8337b826c0d164
2017-12-15 17:57:42 +00:00
and access, including synchronization to other Perkeep servers or backup
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
to cloud storage providers
website: fix remaining old links to /docs/ interestingly, I also discovered that GitHub will properly resolve links that are relative to the root path (e.g. "/doc/foo")... it properly rewrites these links to reference the named file relative to the repository root. also add a /doc/contributing.md file. This will never be served from the website, since we have a redirect handler in place, but is added so that we don't have broken links when browsing the docs on GitHub. Change-Id: I47517a5f6303065df02ac11771dcee56cd06a4b7
2016-05-02 05:20:16 +00:00
* [Client config](/doc/client-config.md): Clients need this configuration file to
website: first pass of s/Camlistore/Perkeep/ on contents A second pass will be needed on the URLs once we have moved all the repos and such. Issue #981 Change-Id: Ibb58f4c4f16481da69e811142e8337b826c0d164
2017-12-15 17:57:42 +00:00
securely connect to your Perkeep server(s)
geocode: support the now-required Google API key and document how to configure Change-Id: Ic4f01c7bf0ad37d06ee76aad53ad99a91d986c03
2018-04-25 18:12:52 +00:00
* [Search Commands](/doc/search-ui.md): Covers the available search operators
* [Configuring Geocoding](/doc/geocoding.md): how to enable geocoding (the `loc:` search operator)
doc: add files vs permanodes explanation The confusion of users regarding files VS permanodes and the related questions comes back very often on IRC or on the mailing-lists. Therefore, this small explanation that we can point them to should help alleviate that confusion. Change-Id: I02acd38754f866acb4fe91c4dfa7e93ef80ac8ea
2018-07-16 17:47:11 +00:00
* [Files or Permanodes](/doc/files-and-permanodes.md): explains the basic difference between a file and a permanode
Initial changes to the website Give a better sense of what camlistore is right away More readable headings on those yellow bars Reduce number of items in the nav Add detail to download and getting started section Turned mailing list page into community page Style changes to the front page from aaron. Reworked the code page Added some pages to fill in, protocol and todo Reorganized docs page Redirect lists to new community page Change-Id: I4e953e53618b93420f9f57aaf48d2d3651977b57
2014-02-06 22:14:19 +00:00
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
## For Developers
Initial changes to the website Give a better sense of what camlistore is right away More readable headings on those yellow bars Reduce number of items in the nav Add detail to download and getting started section Turned mailing list page into community page Style changes to the front page from aaron. Reworked the code page Added some pages to fill in, protocol and todo Reorganized docs page Redirect lists to new community page Change-Id: I4e953e53618b93420f9f57aaf48d2d3651977b57
2014-02-06 22:14:19 +00:00
website: first pass of s/Camlistore/Perkeep/ on contents A second pass will be needed on the URLs once we have moved all the repos and such. Issue #981 Change-Id: Ibb58f4c4f16481da69e811142e8337b826c0d164
2017-12-15 17:57:42 +00:00
If you want to help the development of Perkeep or just want to know more
about the how and why behind Perkeep, these docs are going to help you
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
get started. **Something we didn't cover here that you're interested in?** Ask
on the [mailing list](https://groups.google.com/group/camlistore).
Initial changes to the website Give a better sense of what camlistore is right away More readable headings on those yellow bars Reduce number of items in the nav Add detail to download and getting started section Turned mailing list page into community page Style changes to the front page from aaron. Reworked the code page Added some pages to fill in, protocol and todo Reorganized docs page Redirect lists to new community page Change-Id: I4e953e53618b93420f9f57aaf48d2d3651977b57
2014-02-06 22:14:19 +00:00
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
### Concepts
Initial changes to the website Give a better sense of what camlistore is right away More readable headings on those yellow bars Reduce number of items in the nav Add detail to download and getting started section Turned mailing list page into community page Style changes to the front page from aaron. Reworked the code page Added some pages to fill in, protocol and todo Reorganized docs page Redirect lists to new community page Change-Id: I4e953e53618b93420f9f57aaf48d2d3651977b57
2014-02-06 22:14:19 +00:00
website: fix remaining old links to /docs/ interestingly, I also discovered that GitHub will properly resolve links that are relative to the root path (e.g. "/doc/foo")... it properly rewrites these links to reference the named file relative to the repository root. also add a /doc/contributing.md file. This will never be served from the website, since we have a redirect handler in place, but is added so that we don't have broken links when browsing the docs on GitHub. Change-Id: I47517a5f6303065df02ac11771dcee56cd06a4b7
2016-05-02 05:20:16 +00:00
* [Principles](/doc/principles.md): our base principles, goals, assumptions
* [Terminology](/doc/terms.md): let's agree on terms to stay sane
* [Use Cases](/doc/uses.md): what one might do with all this (or at least our aspirations)
* [Prior Art](/doc/prior-art.md): other projects with similar goals or strategies
doc/readme: Updated Link (#1310) #Issue: The link pointing to "camlistore.org" will redirect back to "perkeep.org" anyways, so updated with relative link. #Change: Updated "Contributing" link from "https://camlistore.org/doc/contributing" to "/code#contributing".
2020-07-01 14:06:24 +00:00
* [Contributing](/code#contributing): how to help
website: fix remaining old links to /docs/ interestingly, I also discovered that GitHub will properly resolve links that are relative to the root path (e.g. "/doc/foo")... it properly rewrites these links to reference the named file relative to the repository root. also add a /doc/contributing.md file. This will never be served from the website, since we have a redirect handler in place, but is added so that we don't have broken links when browsing the docs on GitHub. Change-Id: I47517a5f6303065df02ac11771dcee56cd06a4b7
2016-05-02 05:20:16 +00:00
* [Style guide](/doc/web-ui-styleguide.md) for the Web UI
Initial changes to the website Give a better sense of what camlistore is right away More readable headings on those yellow bars Reduce number of items in the nav Add detail to download and getting started section Turned mailing list page into community page Style changes to the front page from aaron. Reworked the code page Added some pages to fill in, protocol and todo Reorganized docs page Redirect lists to new community page Change-Id: I4e953e53618b93420f9f57aaf48d2d3651977b57
2014-02-06 22:14:19 +00:00
website: video tutorials Change-Id: I59556deafe520d58c5124308f329829dc38b4178
2014-04-18 19:24:41 +00:00
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
### Technical Docs
website: video tutorials Change-Id: I59556deafe520d58c5124308f329829dc38b4178
2014-04-18 19:24:41 +00:00
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
* [Packages](/pkg/): internal API documentation
website: fix remaining old links to /docs/ interestingly, I also discovered that GitHub will properly resolve links that are relative to the root path (e.g. "/doc/foo")... it properly rewrites these links to reference the named file relative to the repository root. also add a /doc/contributing.md file. This will never be served from the website, since we have a redirect handler in place, but is added so that we don't have broken links when browsing the docs on GitHub. Change-Id: I47517a5f6303065df02ac11771dcee56cd06a4b7
2016-05-02 05:20:16 +00:00
* [Architecture](/doc/arch.md): the pieces, layers, and how they interact
website: first pass of s/Camlistore/Perkeep/ on contents A second pass will be needed on the URLs once we have moved all the repos and such. Issue #981 Change-Id: Ibb58f4c4f16481da69e811142e8337b826c0d164
2017-12-15 17:57:42 +00:00
* [Schema](/doc/schema/): how we model data in Perkeep
doc: add jsonsign protocol docs And misc tweaks. Updates #1009 Updates #1007 Change-Id: Ibb750c8cc69763c0a59b72f42bc53f68e3ee120f
2018-01-03 03:24:38 +00:00
* [Protocol](/doc/protocol/): HTTP APIs (discovery, blob storage, JSON signing, ...)
website: fix remaining old links to /docs/ interestingly, I also discovered that GitHub will properly resolve links that are relative to the root path (e.g. "/doc/foo")... it properly rewrites these links to reference the named file relative to the repository root. also add a /doc/contributing.md file. This will never be served from the website, since we have a redirect handler in place, but is added so that we don't have broken links when browsing the docs on GitHub. Change-Id: I47517a5f6303065df02ac11771dcee56cd06a4b7
2016-05-02 05:20:16 +00:00
* [JSON Signing](/doc/json-signing/)
* [Sharing](/doc/sharing.md)
fix typo in Readme.md (#1580)
2021-12-17 23:44:56 +00:00
* [Environment Variables](/doc/environment-vars.md)
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
## Presentations {#presentations}
doc: add lfnw 2018 talk Change-Id: I512a0620b13c0d070db28198271ad2ca0e80ad3b
2018-05-01 02:28:37 +00:00
* 2018-04, **LinuxFest Northwest**: [[slides]](https://docs.google.com/presentation/d/1suYfv3dmjJQ1mMJIG7_D26e5cudZqPcZTPNgrLvTIrI/view) [[video]](https://www.youtube.com/watch?v=PlAU_da_U4s)
doc: presentations -fix fosdem 2014 date and slides link -add fosdem 2015 -add GDG Seattle Change-Id: Id038e0dc32a194805b88e0f5d0ca340903534f3d
2016-05-06 15:01:42 +00:00
* 2016-04, **GDG Seattle**: [[slides]](https://docs.google.com/presentation/d/1AmT5DAL9CrzQFS22i0xJ5SYtXQfrHqOyYiQB7imshdw/view) [[video]](https://www.youtube.com/watch?v=dg6OmoKNbcw)
* 2016-04, **LinuxFest Northwest**: [[slides]](https://docs.google.com/presentation/d/1AmT5DAL9CrzQFS22i0xJ5SYtXQfrHqOyYiQB7imshdw/view) [[video]](https://www.youtube.com/watch?v=8Dk2iVlc67M)
* 2015-02, **FOSDEM**: [[slides]](https://go-talks.appspot.com/github.com/mpl/talks/fosdem-2015/fosdem-20150201.slide) [[video]](https://www.youtube.com/watch?v=oM-MfeflUZ8)
* 2014-02, **FOSDEM**: [[slides]](http://go-talks.appspot.com/github.com/mpl/talks/fosdem-2014/2014-02-02-FOSDEM.slide) [[video]](https://www.youtube.com/watch?v=kBCQq5hfsug) [[WebM]](http://video.fosdem.org/2014/K4601/Sunday/Camlistore.webm)
Add links for the latest presentation Change-Id: I47ab9b831167734892bca5cebc0f7bd3cac39bf6
2016-04-30 21:17:59 +00:00
* 2013-06, **Google Developers Live**: [[video]](https://www.youtube.com/watch?v=yxSzQIwXM1k)
* 2011-05, **São Paolo Perl Conference**: [[slides]](/talks/2011-05-07-Camlistore-Sao-Paolo/)
* 2011-02, **First Introduction**: [[slides]](https://docs.google.com/present/view?id=dgks53wm_2j86hwnhs)
website: convert docs pages to markdown This includes all of the top-level files in the docs folder except for status and terms, which are going to be a little trickier to convert. This includes no editorial changes. There are a few minor stylistic changes (like the auth value table in server-config converted into a list). Text has also been mostly wrapped at 80 columns, which accounts for a lot of the changes as well. Change-Id: I3782158f05d2b3c72e6cb44bff92c46ccc231a96
2015-07-26 21:32:30 +00:00
## Video tutorials {#tutorials}
Add links for the latest presentation Change-Id: I47ab9b831167734892bca5cebc0f7bd3cac39bf6
2016-04-30 21:17:59 +00:00
* 2014-03, [Getting started with Camlistore](https://www.youtube.com/watch?v=RUv-8PhnNp8)
cmd: rename camput to pk-put, and make "pk put" call it A new "put" mode is added to the pk command, so that the "pk put" command can be used to create and upload blobs. What this command does is actually just call the previously named "camput" executable, which is renamed to "pk-put" in this change. This involves adding a new way to register a mode in cmdmain, when such a mode is just meant to call an external binary. To emphasize the distinction, the existing func (to register a sub-command, or a mode) is renamed from RegisterCommand to RegisterMode, and RegisterCommand is now the name of the new func/way. Updates #981 Updates #1056 Change-Id: Ief954c17aa88a376f551df7de4b4e9fe41ad96d1
2018-03-06 21:39:14 +00:00
* 2014-03, [Getting started with pk put and the Camlistore client tools](https://www.youtube.com/watch?v=DdccwBFc5ZI)