Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Retire DJB-era in-tree text docs. #280

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

schmonz
Copy link
Member

@schmonz schmonz commented Jun 27, 2024

We're still using CHANGES, README, and VERSION. All other DJB-era docs have been removed. Much of the information remains available (even updated!) from https://cr.yp.to/qmail.html, and the rest can always be extracted from https://qmail.notqmail.org/netqmail-1.06.tar.gz.

We're still using CHANGES, README, and VERSION. All other DJB-era docs
have been removed. Much of the information remains available (even
updated!) from <https://cr.yp.to/qmail.html>, and the rest can always be
extracted from <https://qmail.notqmail.org/netqmail-1.06.tar.gz>.
@schmonz schmonz added this to the 1.09.1 milestone Jun 27, 2024
@schmonz schmonz added the documentation Improvements or additions to documentation label Jun 27, 2024
@schmonz schmonz force-pushed the schmonz-retire-djb-in-tree-docs branch from 4c27669 to e582cee Compare June 27, 2024 14:01
@schmonz schmonz force-pushed the schmonz-retire-djb-in-tree-docs branch from c0885e6 to 3d4ba4a Compare June 27, 2024 14:30
Copy link

@josuah josuah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that it is better have fewer documentation than out of date documentation.
What to point users at next? There is a link from the README to https://notqmail.org/ currently, which leads to https://notqmail.org/install/, would that work?

There is also https://qmail.notqmail.org/

And the manual pages in-tree.
Maybe https://github.com/notqmail/notqmail/blob/main/qmail.7 is also a good entry point.

@schmonz
Copy link
Member Author

schmonz commented Jun 27, 2024

What to point users at next?

The README link to notqmail.org is probably sufficient for now. Maybe my imagination is poor, but I can't imagine someone looking at notqmail who doesn't know about "Life with qmail", qmail.org, DJB's website, etc.

Anyway, this is a very good reminder to make more progress on #86.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants