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

Create a documentation #80

Open
skoruba opened this issue Sep 26, 2018 · 12 comments
Open

Create a documentation #80

skoruba opened this issue Sep 26, 2018 · 12 comments
Assignees
Labels
docs Documentation help wanted Extra attention is needed task Task

Comments

@skoruba
Copy link
Owner

skoruba commented Sep 26, 2018

Consider:

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

  • Use Github or some external tool

Any suggestions?

@skoruba skoruba added help wanted Extra attention is needed task Task docs Documentation labels Sep 26, 2018
@skoruba skoruba self-assigned this Sep 26, 2018
@skoruba
Copy link
Owner Author

skoruba commented Sep 26, 2018

Consider using: https://readthedocs.org/

@NTurakulov
Copy link

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
Copy link
Owner Author

skoruba commented Nov 6, 2018

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
Copy link

gwinnem commented Nov 11, 2018

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
Copy link

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

@gwinnem
Copy link

gwinnem commented Nov 12, 2018 via email

@skoruba
Copy link
Owner Author

skoruba commented Nov 12, 2018

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

@gwinnem
Copy link

gwinnem commented Nov 12, 2018

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

@RobCodemonkey
Copy link

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

@RobCodemonkey
Copy link

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

@skoruba
Copy link
Owner Author

skoruba commented Nov 18, 2018

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

@skoruba
Copy link
Owner Author

skoruba commented Dec 31, 2018

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

@xmichaelx xmichaelx self-assigned this Jan 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation help wanted Extra attention is needed task Task
Projects
None yet
Development

No branches or pull requests

5 participants