DOC: rework readme - Githubissues

nextcloud / user_external

👥 External user authentication methods like IMAP, SMB and FTP

https://apps.nextcloud.com/apps/user_external

108 stars 64 forks source link

DOC: rework readme #126

Open DJCrashdummy opened 4 years ago

DJCrashdummy commented 4 years ago

unified and corrected php-syntax
reworked IMAP description in the style of the XMPP description to prevent confusion with the order and numeration
added line breaks to XMPP description to make it easier readable
reworked SMB & HTTP heading
added jump-marks to headers for convenience
reordered sections to fit the order in the intro and at https://apps.nextcloud.com/apps/user_external

DJCrashdummy commented 4 years ago

btw: in the brief description on top the additional backends and the "website" (appstore-url: https://apps.nextcloud.com/apps/user_external) would fit.

violoncelloCH commented 4 years ago

hi, thanks very much! would you mind to sign-off on your commit like requested by the Nextcloud contributing guidelines? https://github.com/nextcloud/server/blob/master/.github/CONTRIBUTING.md#sign-your-work this can be done with git commit --amend -s for the last commit and then git push -f to push the changed commit back to github...

DJCrashdummy commented 4 years ago

[...] sign-off on your commit like requested by the Nextcloud contributing guidelines?

sorry @violoncelloCH, i'm not a developer and thus i don't use the CLI in this case... is this somehow possible via the github-GUI?

violoncelloCH commented 4 years ago

[...] sign-off on your commit like requested by the Nextcloud contributing guidelines?

sorry @violoncelloCH, i'm not a developer and thus i don't use the CLI in this case... is this somehow possible via the github-GUI?

I see... basically you just need to have Signed-off-by: Your Name <your@mail.domain> as last line of the commit message... However I don't know if Github allows you to modify a commit message :/

DJCrashdummy commented 4 years ago

sorry for asking already answered questions. :man_facepalming: i've read the link again and finally got it. :wink:

However I don't know if Github allows you to modify a commit message

i've looked around quite a while, but i'm afraid it's not possible.

anyway... i'd prefer to not make my email-address public because of possible spam! :unamused:

DJCrashdummy commented 4 years ago

are there for 2, 4 and 5 default values...? or is there an other reason to have this values in the example? if not, i would rather use 4 => false (create uids with domains to be on the safe side) and 5 => true (groups can still easily be deleted afterwards) to prevent possible future problems for copycats.

violoncelloCH commented 4 years ago

as you can see here https://github.com/nextcloud/user_external/blob/147b127cc81377172cf841f8d3ef0b207ab5905a/lib/imap.php#L38-L46 there are default values for all of those... however those are more something which grew historically; meaning the default values were set so that nothing changes for existing setups which don't configure a value for the additional parameters... so I guess it's safe to give a different example in the Readme if it's sensible and we can explain the choice :)