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

docs(README): Expand and re-organize everything #558

Merged
merged 2 commits into from
Feb 13, 2024

Conversation

joshtrichards
Copy link
Member

@joshtrichards joshtrichards commented Feb 12, 2024

  • New sections
  • Helps the reader address nuisance triggers properly
  • Explains what disabling this app accomplishes/doesn't accomplish
  • Addresses versioning/releases/tagging topic since this is now a shipped app
  • Adds numerous related documentation links for things often confused with this app (e.g. suspicious_login app, using fail2ban with Nextcloud, etc)
  • A basic usage section
  • Adds help & contributing links

Closes #500 (as much as is realistic outside of publishing newer versions in the app store which isn't presently expected for shipped apps)

Screenshot:

(ignore the artifact above the "How it works" heading, which is just some weird bug in Firefox's screenshot feature that gets triggered on this page)

image

* New sections
* Helps the reader address nuisance triggers properly
* Explains what disabling this app accomplishes/doesn't accomplish
* Addresses versioning/releases/tagging topic since this is now a shipped app (fixes #500 as much as is realistic outside of publishing newer versions in the app store which isn't presently expected for shipped apps)
* Adds numerous related documentation links for things often confused with this app (e.g. `suspicious_login` app, using `fail2ban` with Nextcloud, etc)
* A basic usage section
* Adds help & contributing links

Signed-off-by: Josh <[email protected]>
@joshtrichards joshtrichards merged commit 4633f8a into master Feb 13, 2024
28 checks passed
@joshtrichards joshtrichards deleted the docs/readme-2024 branch February 13, 2024 11:55
Copy link

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

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

Successfully merging this pull request may close these issues.

Numbering of versions
4 participants