Commit e82968f3 authored by David Seaward's avatar David Seaward
Browse files

basic site


Signed-off-by: David Seaward's avatarDavid Seaward <david.seaward@puri.sm>
parent eb53725d
Purist services notebook
========================
# Services notebook
**project** | [wiki] | [tracker] | *snippets*
[homepage] | [project] | [subprojects] | [wiki] | [tracker] |
[chat] | [microblog]
Project management, software architecture and UX design for Purist
applications and services. See below for an overview. See [wiki]
for a page index.
A Lektor-based static site for ethical service definitions, standards
and components. Content hosted at <https://liberty.one>
[project]: https://code.puri.sm/purist/services
[wiki]: https://code.puri.sm/purist/services/wiki
[tracker]: https://code.puri.sm/purist/services/issues
[snippets]: https://code.puri.sm/purist/snippets/src/master/services
## Install from source
## Overview
1. Download source
An easy-to-install private communication suite that users can access
from all their devices, secure from monitoring by the operator or
third-parties, and optionally host themselves. [Read more about our
approach...](./wiki/project_overview)
```
mkdir liberty_services
git clone git@source.puri.sm:liberty/services.git .
```
### Audience
2. Install Lektor with pipsi. (The Debian package doesn't include the
admin interface, see <https://bugs.debian.org/935378>.)
* This notebook is for technical readers interested in
*software engineering* and *design*. See setup and usage instructions
below.
* For programmers interested in *active development*, see
[code.puri.sm/purist](https://code.puri.sm/purist)
* ~~For users wanting to sign-up for services and download applications, see <https://puri.st>~~ (not yet available)
```
sudo apt install pipsi
pipsi install lektor
```
## Setup
To view issues and wiki pages, no setup is required, simply follow the
links.
## Usage
To add issues and modify wiki pages, you must register and log into
<https://code.puri.sm>
1. Launch Lektor in browser
To make contributions to the wiki via Git:
```
cd liberty_services
lektor server --browse
```
* Download the wiki content with Git
* From the command line, navigate to the base repo folder
* Create a self-referencing symlink with
`ln -s /full/path/to/base/folder`
* Rename the new symlink folder to `wiki`
2. Click the "Pencil" button to edit a page.
(This symlink to ourselves is required because Gogs requires that our
relative paths start `./wiki` - see
[Gogs #2080](https://github.com/gogits/gogs/issues/2080))
3. Click the "Save" button to make changes.
## Usage
4. Once you're happy, commit the changes.
To edit a local copy of the wiki:
## Build and deploy
* Open `Home.md` in a compatible editor (for example, ReText)
* Click links to the live preview to open linked files
Assumes you can ssh on to the target.
## Submit support issues by email only
1. Build the site
The tracker associated with this repo is used as a central location for
high-level public planning, not support issues.
```
lektor build
```
Please email any support issues to <support@puri.sm> rather than adding
an issue to the tracker. Any support issues in the tracker will be
closed.
2. Confirm build was successful (no error messages).
## Sharing and contributions
3. Deploy
Purist services notebook <br />
<https://code.puri.sm/purist/services> <br />
Copyright 2017-2018 Purism SPC and contributors <br />
SPDX-License-Identifier: CC-BY-SA-4.0
```
lektor deploy <target>
```
Shared under CC-BY-SA-4.0, see [COPYING.BYSA.md](https://code.puri.sm/purist/services/wiki/COPYING.BYSA)
for details. We adhere to the Contributor Covenant 1.4 without
modification, see [CODE_OF_CONDUCT.md](https://code.puri.sm/purist/services/wiki/CODE_OF_CONDUCT)
for details. Contributions under the same terms are welcome.
<!-- Links -->
Contributions and license notices from other sources are listed in
[COPYING.md](https://code.puri.sm/purist/services/wiki/COPYING)
[homepage]: https://librem.one
[project]: https://source.puri.sm/liberty/services
[subprojects]: https://source.puri.sm/liberty
[wiki]: https://source.puri.sm/liberty/services/wikis
[tracker]: https://source.puri.sm/groups/liberty/-/issues
[chat]: https://matrix.to/#/#community-librem-one:talk.puri.sm
[microblog]: https://social.librem.one/@doublerainbows
[COPYING.BYSA.md]: COPYING.BYSA.md
[CODE_OF_CONDUCT.md]: CODE_OF_CONDUCT.md
[CONTRIBUTING.DCO.md]: CONTRIBUTING.DCO.md
[COPYING.md]: COPYING.md
[CONTRIBUTING.md]: CONTRIBUTING.md
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment