leantime icon indicating copy to clipboard operation
leantime copied to clipboard

Published 20 hours ago • verified publisher icon Leantime

Write documentation

Open marcelfolaron opened this issue 1 year ago • 7 comments

Our documentation needs an overhaul and be updated throughout. This may need someone who has worked with Leantime before but can also be a good beginner task if you want to learn more about Leantime. Docs Repo at: https://github.com/Leantime/docs

marcelfolaron avatar Oct 04 '23 19:10 marcelfolaron

Hey, I'd be happy to. I saw the comment got deleted. Are you still interested?

On Thu, Oct 5, 2023 at 10:46 AM Bhuwan Upadhyay @.***> wrote:

hey there Can you assign me this issue

— Reply to this email directly, view it on GitHub https://github.com/Leantime/leantime/issues/1950#issuecomment-1749058059, or unsubscribe https://github.com/notifications/unsubscribe-auth/ALG4EFXGJUDYCYN52CFMCMTX53B4DAVCNFSM6AAAAAA5TFAI2WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONBZGA2TQMBVHE . You are receiving this because you authored the thread.Message ID: @.***>

marcelfolaron avatar Oct 05 '23 17:10 marcelfolaron

@marcelfolaron hey i am interested..what needs to be changed

shubhankar-mern avatar Oct 08 '23 17:10 shubhankar-mern

Thank you! I think there are a couple large topics we could revisit:

Installation

  • Ubuntu using apache or nginx. (big plus for setting up ssl certificates with lets encrypt)
  • I think the docker installation is in fairly good shape but could use a review.
  • Revers proxy set up using traefic/nginx/authentik

Configuration

  • detailed description of .env variables
  • SMTP Configuration
  • LDAP configuration
  • OIDC configuration
  • S3 configuration

API Usage

  • Connecting to the jsonRPC api
  • Examples of using the API

Plugin development (@harrellbm)

  • Creating plugins
  • Hooking into event structure (events/filters)

PHPDocs Docs

  • The api documentation is based on PHPDoc statements. It would be really good to add more detailed doc descriptions within each service class.
  • Similarly the hooks are also getting their details from the code itself and could use more information

Put your name behind any of the items you'd like to work on.

marcelfolaron avatar Oct 08 '23 23:10 marcelfolaron

I will start working on some of the basic info around creating plugins 👍🏻

harrellbm avatar Oct 12 '23 00:10 harrellbm

Thank you! I added your name to the headline

marcelfolaron avatar Oct 12 '23 00:10 marcelfolaron

would like to work on API Usage

lcrojano avatar Oct 24 '23 20:10 lcrojano

OIDC configuration

I'd really like some info on this! :pray:

jdaviescoates avatar Nov 07 '23 11:11 jdaviescoates