summaryrefslogtreecommitdiff
path: root/keymanager/docs
diff options
context:
space:
mode:
Diffstat (limited to 'keymanager/docs')
-rw-r--r--keymanager/docs/leap-commit-template7
-rw-r--r--keymanager/docs/leap-commit-template.README47
-rw-r--r--keymanager/docs/soledad-documents.rst77
3 files changed, 0 insertions, 131 deletions
diff --git a/keymanager/docs/leap-commit-template b/keymanager/docs/leap-commit-template
deleted file mode 100644
index 8a5c7cd0..00000000
--- a/keymanager/docs/leap-commit-template
+++ /dev/null
@@ -1,7 +0,0 @@
-[bug|feat|docs|style|refactor|test|pkg|i18n] ...
-...
-
-- Resolves: #XYZ
-- Related: #XYZ
-- Documentation: #XYZ
-- Releases: XYZ
diff --git a/keymanager/docs/leap-commit-template.README b/keymanager/docs/leap-commit-template.README
deleted file mode 100644
index ce8809e7..00000000
--- a/keymanager/docs/leap-commit-template.README
+++ /dev/null
@@ -1,47 +0,0 @@
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-HOW TO USE THIS TEMPLATE:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Run `git config commit.template docs/leap-commit-template` or
-edit the .git/config for this project and add
-`template = docs/leap-commit-template`
-under the [commit] block
-
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-COMMIT TEMPLATE FORMAT EXPLAINED
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-[type] <subject>
-
-<body>
-<footer>
-
-Type should be one of the following:
-- bug (bug fix)
-- feat (new feature)
-- docs (changes to documentation)
-- style (formatting, pep8 violations, etc; no code change)
-- refactor (refactoring production code)
-- test (adding missing tests, refactoring tests; no production code change)
-- pkg (packaging related changes; no production code change)
-- i18n translation related changes
-
-Subject should use imperative tone and say what you did.
-For example, use 'change', NOT 'changed' or 'changes'.
-
-The body should go into detail about changes made.
-
-The footer should contain any issue references or actions.
-You can use one or several of the following:
-
-- Resolves: #XYZ
-- Related: #XYZ
-- Documentation: #XYZ
-- Releases: XYZ
-
-The Documentation field should be included in every new feature commit, and it
-should link to an issue in the bug tracker where the new feature is analyzed
-and documented.
-
-For a full example of how to write a good commit message, check out
-https://github.com/sparkbox/how_to/tree/master/style/git
diff --git a/keymanager/docs/soledad-documents.rst b/keymanager/docs/soledad-documents.rst
deleted file mode 100644
index 67055b2f..00000000
--- a/keymanager/docs/soledad-documents.rst
+++ /dev/null
@@ -1,77 +0,0 @@
-=================
-Soledad Documents
-=================
-
-KeyManager uses two types of documents for the keyring:
-
-* key document, that stores each gpg key.
-
-* active document, that relates an address to its corresponding key.
-
-
-Each key can have 0 or more active documents with a different email address
-each:
-
-::
-
- .-------------. .-------------.
- | foo@foo.com | | bar@bar.com |
- '-------------' '-------------'
- | |
- | .-----------. |
- | | | |
- | | key | |
- '----->| |<----'
- | |
- '-----------'
-
-
-Fields in a key document:
-
-* uids
-
-* fingerprint
-
-* key_data
-
-* private. bool marking if the key is private or public
-
-* length
-
-* expiry_date
-
-* refreshed_at
-
-* version = 1
-
-* type = "OpenPGPKey"
-
-* tags = ["keymanager-key"]
-
-
-Fields in an active document:
-
-* address
-
-* fingerprint
-
-* private
-
-* validation
-
-* last_audited_at
-
-* encr_used
-
-* sign_used
-
-* version = 1
-
-* type = "OpenPGPKey-active"
-
-* tags = ["keymanager-active"]
-
-
-The meaning of validation, encr_used and sign_used is related to the `Transitional Key Validation`_
-
-.. _Transitional Key Validation: https://leap.se/en/docs/design/transitional-key-validation