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

JAMES-3187 Updates to "Concepts/Storage" section of new documentation #201

Merged
merged 5 commits into from Aug 19, 2020
Merged

JAMES-3187 Updates to "Concepts/Storage" section of new documentation #201

merged 5 commits into from Aug 19, 2020

Conversation

dleangen
Copy link
Contributor

@dleangen dleangen commented Jun 5, 2020

Updates to the Storage section.

Would be great to get some help with how James handles storage.

Please also comment on any concepts that I have missed, or anything that may not be correct.

Thanks!

@ieugen
Copy link
Member

ieugen commented Jun 8, 2020

Helllo David,

I like the history lesson. I think we should mark that as History. I believe most of those RFC's are obsolete. I also believe (but did not check) that some RFC's that James implements are obsolete by other RFC's. Especially in the email format.

Regarding your contributions I think we should add it. We can always improve it later. I can help you with more technical docs about the storage part.

Did you check out this information? https://james.apache.org/mailbox/index.html .
We can start by migrating that first and then improve on it.
The sources are here https://git.apache.org/repos/asf?p=james-site.git;a=tree;f=www;h=1c66d9f2f309f030a75a3bb7970c0ed8d6f19638;hb=HEAD .

I know there is this list here that should be migrated: https://james.apache.org/server/rfcs.html .
I would also like to improve it. Make it a table and mention what is implemented in James and from which version.

@dleangen dleangen changed the title JAMES-3187 Updates to Storage section of new documentation JAMES-3187 Updates to "Storage" section of new documentation Jun 14, 2020
@dleangen dleangen marked this pull request as draft June 14, 2020 08:05
@dleangen
Copy link
Contributor Author

dleangen commented Jul 7, 2020

Did you check out this information? https://james.apache.org/mailbox/index.html

I do not find it useful, and even if it were useful, it does not belong in this section.

I know there is this list here that should be migrated: https://james.apache.org/server/rfcs.html
I would also like to improve it. Make it a table and mention what is implemented in James and from which version.

I don't mind adding this in some other section, but the list in its current form is not useful.

A list showing which RFCs are actually implemented could be useful, and even more so if it can actually point to the right places in the code.

@dleangen dleangen marked this pull request as ready for review July 7, 2020 11:57
@dleangen
Copy link
Contributor Author

dleangen commented Jul 7, 2020

Ready for review before merging. Will wait a few days for comments. (Even after merge we can always update at any time.)

@ieugen ieugen self-requested a review July 7, 2020 15:31
docs/modules/concepts/pages/storage/users.adoc Outdated Show resolved Hide resolved
docs/modules/concepts/pages/storage/users.adoc Outdated Show resolved Hide resolved
docs/modules/concepts/pages/storage/users.adoc Outdated Show resolved Hide resolved
docs/modules/concepts/pages/storage/index.adoc Outdated Show resolved Hide resolved
@dleangen dleangen changed the title JAMES-3187 Updates to "Storage" section of new documentation JAMES-3187 Updates to "Concepts/Storage" section of new documentation Aug 18, 2020
@dleangen
Copy link
Contributor Author

I would like to merge this PR. Please let me know if you have any objections. I will go ahead by tomorrow morning otherwise, as the risk is very low and the text can always be changed.

@dleangen dleangen merged commit 678397f into apache:master Aug 19, 2020
@dleangen dleangen deleted the docs/concepts/storage branch August 19, 2020 05:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants