Identityserver4.admin: Create a documentation

[skoruba]

Consider:

• How to create a documentation - what document format to use

• Use Github or some external tool

Any suggestions?

[skoruba]

Consider using: https://readthedocs.org/

[NTurakulov]

Hey, @skoruba
First of all - GREAT THANK YOU for you project! I believe you make a realy great job!

I've found you're project just yesterday and still learning the code and some docs would be very helpfull. However I see that you develop this project almost alone and actually don't have time for this. As Identity Server Admin is very important for me and my projects I'm gonna spend some with it and I hope I could make some contribution. I like the idea to use Read the Docs as a platform so could you just register a repo there and I will write some paragraphs there? Maybe they will be dummy a bit for the first time, copy-pastes from readme and some (formatted) notes while my explorations but that could be a start? What do you think?

[skoruba]

Hey @NTurakulov,

It will be great - please feel free to send PR. I will be happy for that. :)

Maybe - is it necesarry to prepare some environment from me?
Thanks!

[gwinnem]

Maybe check out where the documentation for Identityserver4 is being built as a reference ?
I will be using this project in our production applications and would be happy to contribute with howtos etc during the process.

[NTurakulov]

Good idea! Checked it - and yes, they use Read The Docs =)

[gwinnem]

Can you prepare a environment where I can submit some documentation as I continue implementing your software into our environment

Sent from my iPhone

On 12.11.2018, at 08:11, Nozim Turakulov [e-mail] wrote:

Good idea! Checked it - and yes, they use Read The Docs =)

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.

[skoruba]

I have to figure out - how to connect Read the docs to Github repo - for automatic build/publish. :)

[gwinnem]

Just pop me an email when you have something up and running.

[RobCodemonkey]

Likewise - I'll be working with this so would love to contribute. Docs and/or code :)

[RobCodemonkey]

@skoruba It looks like it's fairly simple to set up the integration with gitbug and readthedocs:
https://github.com/rtfd/readthedocs.org

[skoruba]

Thanks for these details - I will check it. :)

[skoruba]

I've added the support for docs on http://readthedocs.org
I've tried to add the homepage - currently the preview is available on dev branch:
https://github.com/skoruba/IdentityServer4.Admin/tree/dev/docs
and
https://skoruba-identityserver4-admin.readthedocs.io/en/dev/

Thanks for suggestions @RobCodemonkey @NTurakulov @gwinnem