Disroot
/
gpg-lacre
9
15
Fork 4
Code Issues 29 Pull Requests 1 Releases 2 Wiki Activity

Refresh README #126

New Issue
Open
opened 2023-05-20 14:04:33 +02:00 by pfm · 1 comment
pfm commented 2023-05-20 14:04:33 +02:00
Collaborator
Copy Link

We should update the README and other documentation to:

  • Reflect that it's no longer 2021: funding has ended and we're moving on.
  • We recommend specific Python versions known to work well with Lacre (3.8 for sure, probably 3.9 too).
  • Give a hint about simple and advanced filters.
  • Explain all types of tests available.
  • Document what's configurable and how to decide which options to use.

We should probably adjust documentation structure too.

README

  • Project history (i.e. relation to gpg-mailgate, original developers, license).
  • Overview of the features.
  • Known limitations.
  • Links to: installation manual, more detailed documentation.

INSTALL

  • Installation and configuration manual.
  • Overview of configuration options.

Other documents

  • Kept in doc/ directory.
  • Anything that no longer fits in README should be moved here.
We should update the README and other documentation to: * Reflect that it's no longer 2021: funding has ended and we're moving on. * We recommend specific Python versions known to work well with Lacre (3.8 for sure, probably 3.9 too). * Give a hint about simple and advanced filters. * Explain all types of tests available. * Document what's configurable and how to decide which options to use. We should probably adjust documentation structure too. # README - Project history (i.e. relation to gpg-mailgate, original developers, license). - Overview of the features. - Known limitations. - Links to: installation manual, more detailed documentation. # INSTALL - Installation and configuration manual. - Overview of configuration options. # Other documents - Kept in `doc/` directory. - Anything that no longer fits in README should be moved here.
pfm added the
DOCUMENTATION
 label 2023-05-20 14:04:39 +02:00
pfm self-assigned this 2023-05-20 14:04:44 +02:00
pfm commented 2023-05-20 14:26:01 +02:00
Author
Collaborator
Copy Link

Include a note about key-server not having been tested thoroughly.

Perhaps create a ticket to test it eventually?

Include a note about key-server not having been tested thoroughly. Perhaps create a ticket to test it eventually?
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
main
error-handling
uncoupleFE
fe_theme_st
php_update
muppdev
v0.2.2
v0.2.1
v0.2
v0.2-RC3
v0.2-RC2
v0.2-RC1
PII-2
PII-1
v0.1
v0.1-RC2
v0.1-RC1
failed-tests
Labels
Clear labels   
ANSIBLE

   
BUG

Something that's not working properly

  
CODE

   
DEVELOPMENT

   
DOCUMENTATION

Documentation

  
FEEDBACK

Suggestions and comments

  
FIX

A solution or patch for an issue

  
HOWTOs

Guides and tutorials

  
IDEA

Potential improvements and things to consider when time allows

  
INFRA

   
ISSUE

A problem

  
MAILSERVER

   
TESTS

   
To-Be-Reviewed

We should discuss these issues and decide what to do about them. They are candidates to be closed without further action or their scope might change.

  
WEB

   
WEBSITE

Lacre website related

No Label
ANSIBLE
BUG
CODE
DEVELOPMENT
DOCUMENTATION
FEEDBACK
FIX
HOWTOs
IDEA
INFRA
ISSUE
MAILSERVER
TESTS
To-Be-Reviewed
WEB
WEBSITE
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
pfm
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Disroot/gpg-lacre#126
No description provided.
Delete Branch "%!s(<nil>)"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?