-
Notifications
You must be signed in to change notification settings - Fork 545
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
Adding a getting started doc page #745
base: master
Are you sure you want to change the base?
Conversation
Hey @jparrill, thanks for the contribution. Have you checked the usage#docker docs? Most of the content in this one is covered in there, maybe Getting Started is a better name for that part of the documentation? Apart from that, I think you forgot to push the new screenshots. |
39d797b
to
f430881
Compare
Maybe it's better covered there, and a name change could help. From my PoV when I've checked the docs it was a bit difficult to just bootstrap the server with the parameters and then add the bookmarks. As you mention, changing the name of the Docker usage and putting (maybe a refernce) in the README.md could help on the visibility. Do you want me to follow this path or do you preffer to have a separated Getting Started section with the most basic usage of the app? w/e for me is fine :). PS: Added the screenshots, you were right xD
|
Ummm, I would do a mix of what we have now. I believe that most of the content here can be divided into two sections:
There is some work around thin over at #703, where I'm trying to restructure the documentation step by step. What do you think? |
f430881
to
0d15a7a
Compare
I've done some changes based on your comment, could you please review @fmartingr when you have time? |
0d15a7a
to
cd33556
Compare
This allow the product to lower the entry level barrier Signed-off-by: Juan Manuel Parrilla Madrid <jparrill@redhat.com>
cd33556
to
97f758b
Compare
|
||
<!-- /TOC --> | ||
|
||
## Running Docker Container |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have been giving a thought and I believe is better to point the installation to the proper installation docs, so we don't have repeated documentation around. Hopefully we will maintain that properly and up to date and when the documentation site is up an ready it will be easy to navigate through sections. What do you think?
Added a new Getting Started page with the basics of how to bootstrap the main functionality.
This allow the product to lower the entry level barrier