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

Documentation needs end-user documentation #26

Open
Joebeazelman opened this issue Jul 23, 2019 · 5 comments
Open

Documentation needs end-user documentation #26

Joebeazelman opened this issue Jul 23, 2019 · 5 comments
Labels
enhancement New feature or request

Comments

@Joebeazelman
Copy link

Getting started with PiranhaCMS is very difficult for a new user. The existing documentation is written for developers who have already committed to using PiranhaCMS. It's not geared towards .NET developers with no prior knowledge or end-user who wants to evaluate it.

When I fired up PiranhaCMS for a second time today, it started out in the site mode, but I needed to change some of the content. There was no single place in the documentation which describes how to login into the manager. A google search didn't yield any specific results. Since I couldn't remember how I managed to login into the manager the first time I installed PiranhaCMS, I became frustrated.

Eventually, I opened up the database using an SQLLite client to find the username and guessed the admin password. I also found the URL for the manager by searching my browser's history. As I am writing this, I wondered if the username and password were somehow given during the installation process. A search in VS gave me "Setup/index.cshtml" and the username and password appear in the HTML. This is the last place I would expect to find this information!

I understand the vision for a lightweight and highly configurable CMS system, but without adequate user level documentation, it may be one of the dozens of CMSes that wind up in the recycling bin during an evaluation out of frustration. I would add user level documentation covering everything from installation to managing content.

@tidyui
Copy link
Member

tidyui commented Jul 23, 2019

Hi there. Like you say, the default user & password is probably stated in the installer only and it would be a good idea to have it written in the default seeded content as well. A long term goal is also to improve the installer to allow you to set up your own username & password.

When it comes to end-user documentation chances are low that we will provide it. Like you say Piranha is geared towards developers, so technical documentation will always be our focus. We try our best to expand and keep the existing docs updated and after 7.0 is released there will be a massive overhaul to document the new architecture. End-user documentation, or how I interpret it, ie docs for content managers is not in the roadmap in the near future.

Best regards

Håkan

@tidyui
Copy link
Member

tidyui commented Aug 18, 2019

Just wanted to let you know that we’ve changed our view on this and will most likely work on providing a end user section in the documentation.

Regards

@Joebeazelman
Copy link
Author

Great news! Given the stock templates and features will need certain modification by developers, the end-user documentation is geared towards them as well.

@tidyui
Copy link
Member

tidyui commented Sep 10, 2019

End user docs will be focused on the content editors and how the manager works. As an example, take a look at how our docs looked for the old legacy version of Piranha.

http://legacy.piranhacms.org/docs/content

Regards

@tidyui
Copy link
Member

tidyui commented Apr 2, 2020

Moving this to the documentation repo.

@tidyui tidyui transferred this issue from PiranhaCMS/piranha.core Apr 2, 2020
@tidyui tidyui added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 2, 2020
@tidyui tidyui removed the documentation Improvements or additions to documentation label Apr 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants