HTML Logo by World Wide Web Consortium (www.w3.org). Click to learn more about our commitment to accessibility and standards.

Moving forward with Composr

ocPortal has been relaunched as Composr CMS, which is now in beta. ocPortal 9 will be superseded by Composr 10.

Head over to compo.sr for our new site, and to our migration roadmap. Existing ocPortal member accounts have been mirrored.


What needs to be documented better?

Login / Search

 [ Join | More ]
 
Posted
Rating:
#40711 (In Topic #9081)
Avatar

We are currently working on the documentation for version 4. This process will involve documenting new features, but also improving the existing documentation and extending it in parts.

This is your opportunity to tell us what we should do.

We are aware that our documentation isn't perfect, and that one particular thing we could do better is to lay out specific instructions on how to achieve specific tasks. That isn't quite as easy to do as it might seem, as ocPortal can be used in many different ways, but still, there are many common tasks I'm sure we could describe better.

So please let us know any area in which the documentation can be improved, including:
  • Functionality that needs describing better
  • Specific tasks that we need to lay out
  • Things we might have entirely missed
  • General things that we can explain that would be useful
  • Presentation improvements we could make
  • Searching and navigation improvements we could make
  • whatever else you think appropriate to mention

If you don't want to post publicly please feel free to send me a PT (a whisper).


Become a fan of ocPortal on Facebook or add me as a friend. Add me on on Twitter.
Was I helpful?
  • If not, please let us know how we can do better (please try and propose any bigger ideas in such a way that they are fundable and scalable).
  • If so, please let others know about ocPortal whenever you see the opportunity.
  • If my reply is too Vulcan or expressed too much in business-strategy terms, and not particularly personal, I apologise. As a company & project maintainer, time is very limited to me, so usually when I write a reply I try and make it generic advice to all readers. I'm also naturally a joined-up thinker, so I always express my thoughts in combined business and technical terms. I recognise not everyone likes that, don't let my Vulcan-thinking stop you enjoying ocPortal on fun personal projects.
  • If my response can inspire a community tutorial, that's a great way of giving back to the project as a user.
Back to the top
 
Posted
Rating:
#40712
Avatar

Community saint

Blocks, blocks, blocks, blocks…;-)

The one missing item that could be improved in the blocks docs is a couple of examples for each one.

A great example is main_content block. Current the doc states: "The content type to use (e.g. 'download'). Default: 'download'.". Unless folks have a lot of time on their hands to try various combinations other than download, basically this block would only be used for download since users would have no real way of figuring out the other options besides trial and error.

Additionally (and I'm not sure the blocks outline page is the best place for it, but I'll throw it out there) a caveat entry or link to a different page outlining same. A good example here is the forum block(s). One can enter a title of a forum to pull from, however, what if one has two subforums with the same title under two different parents?

Just my immediate $0.02 worth.

I'm working on building a new site and it's based on Beta 7, so I'll submit a much more detailed report on the entire OCP4 package in the near future. I'll try to get that done before RC is declared as I'm still finding a couple of niggling bugs.

"no violence, no hate, no pain, no enemies
just peace, unity, tolerance and love" - The Beloved

OCP V7 | Advocating monetary reform - FreeOurMoney

Need OCP friendly hosting? Look no further:
Web Hosting, Reseller Hosting, and Dedicated Servers w/cPanel - Elief! - Official hosting partner for ocPortal.
Back to the top
 
Posted
Rating:
#40714
Avatar

Community saint

Considering I originally opened ocpower.info ( changed to a theme site which will open back up after the final version of 4) for this purpose I would be glad to help.

Things I think should be in it are FAQ's so questions that get asked a lot.

A few questions that get asked to me a lot when helping people use it for the first time is:

Why does it ask for admin password and site password?
I Do tell them the one password is for the config file so it should not be the same as the admin password.

why does the quck install ask for the ftp info and then ask for ftp info again on the set up, should it not already have it from the first time?
I do not have an answer to this one but assume that the quick install needs it for the creation of files and it is not remembered for the site set up wizard.

How do you upload pictures to the gallery?
Can not remember off the top of my head but usually I do explain it the best I can

Another question I get during the explaining is why does it have upload and url? I think I made a topic on this one after one of my friends was really confused about it but still a common question i get.

All I can think of right now.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40718
Avatar

Community saint

Another one for the FAQ idea I mentioned.
I just got done installing the beta and remembered this one being asked a lot.

Whats the difference between scope and description and do they have to be the same or can they be different?
I my self just make them the same.  :P

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40725
Avatar

These are all great - thanks very much. Keep it up. :)

Back to the top
 
Posted
Rating:
#40729
Avatar

Community saint

I'm trying to compile a list, but I suspect it will miss RC1.

Your original concept of aiming this rock-solid CMS at:
  • commercial users
  • knowledgeable user community
fails to take into account the 'average-Joe' who wants a CMS, but who is not conversant with how the core elements are designed.

Most average users want documentation that says something like "do this" and "you get this". That way they get a CMS that works for them, and they don't worry about the 'why'!

The more discerning (knowledgeable) user will ultimately drill down deeper to make things work the way they want it to.

To this end, Amy's FAQ idea may go a long way towards meeting the needs of 'average-Joe' because, yet again, reading complex documentation is beyond their needs. A quick reference to how a 'module' or 'block' works is just about acceptable!

I'll continue to try to put together my ideas in a more cohesive manner - but don't hold your breath!

 :(

Take my advice. I'm not using it!

View my working ocPortal site (version 9.x.x) at Anglo-Indian Portal
Back to the top
 
Posted
Rating:
#40734
Avatar

Community saint

I do agree with you fletch and I know the average-joe/jane does not want to spent a lot of time reading to get it working the way they want.
They want to be able to find it quickly and have it easy to understand.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40739
Avatar

Thanks everybody, this has been a great help.

A quick run through of some of the comments so far…

SoccerDad - I've been going through the blocks, and you're right, it's pretty dreadful. I didn't realise it was as confusing as it is. I'm overhauling the block wizard, adding better descriptions, drop-down lists for choosing things,  checkboxes, and a block preview function.

amichan - I've put one of your points onto the FAQ, and the rest I have handled by improving the descriptions within the system itself. From our point of view the best approach is to avoid questions ever arising by having a user-friendly system, so that's my goal here.

Fletch - We completely agree. We have plans in the pipeline to provide more instructive documentation which I expect to come to fruition soon. These plans are separate from our tutorial update, so please don't feel we're not listening just because the structure of the tutorials isn't changing a lot.


Become a fan of ocPortal on Facebook or add me as a friend. Add me on on Twitter.
Was I helpful?
  • If not, please let us know how we can do better (please try and propose any bigger ideas in such a way that they are fundable and scalable).
  • If so, please let others know about ocPortal whenever you see the opportunity.
  • If my reply is too Vulcan or expressed too much in business-strategy terms, and not particularly personal, I apologise. As a company & project maintainer, time is very limited to me, so usually when I write a reply I try and make it generic advice to all readers. I'm also naturally a joined-up thinker, so I always express my thoughts in combined business and technical terms. I recognise not everyone likes that, don't let my Vulcan-thinking stop you enjoying ocPortal on fun personal projects.
  • If my response can inspire a community tutorial, that's a great way of giving back to the project as a user.
Back to the top
 
Posted
Rating:
#40742
Avatar

Community saint

You have an FAQ already?
Where do I find it at?
Any way thanks glad you liked the ideas I will see if I can remember the other questions I get asks and also see if I can come up with other things to add.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40744
Avatar

FAQ is located in the documentation zone:
ocPortal/ocProducts FAQ


Become a fan of ocPortal on Facebook or add me as a friend. Add me on on Twitter.
Was I helpful?
  • If not, please let us know how we can do better (please try and propose any bigger ideas in such a way that they are fundable and scalable).
  • If so, please let others know about ocPortal whenever you see the opportunity.
  • If my reply is too Vulcan or expressed too much in business-strategy terms, and not particularly personal, I apologise. As a company & project maintainer, time is very limited to me, so usually when I write a reply I try and make it generic advice to all readers. I'm also naturally a joined-up thinker, so I always express my thoughts in combined business and technical terms. I recognise not everyone likes that, don't let my Vulcan-thinking stop you enjoying ocPortal on fun personal projects.
  • If my response can inspire a community tutorial, that's a great way of giving back to the project as a user.
Back to the top
 
Posted
Rating:
#40747
Avatar

Community saint

Oh I missed that. I do not go to that to often do to it taking hours or more to find what I am looking for.
Thats what this thread is for to make it so it does not take hours on that part of this site.
I will keep thinking of questions I get asked as I know there are more just can not think of any off the top of my head.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40859
Avatar

Community saint

The staff page could be added to the FAQ.

Well not sure how many ask about it but I was trying to find it and could not find it so was unsure how to change the content of the page and the edit botton on that page does not allow you to change the roles and real name.

Any way the faq could say this.

How do you change the fields in the staff page?
Go to the admin cp and then security and then staff.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40860
Avatar

Community saint

The staff page could be added to the FAQ.

Well not sure how many ask about it but I was trying to find it and could not find it so was unsure how to change the content of the page and the edit botton on that page does not allow you to change the roles and real name.

Any way the faq could say this.

How do you change the fields in the staff page?
Go to the admin cp and then security and then staff.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40865
Avatar

Thanks, we'll put some more into the documentation about it and I might tweak the interface also.


Become a fan of ocPortal on Facebook or add me as a friend. Add me on on Twitter.
Was I helpful?
  • If not, please let us know how we can do better (please try and propose any bigger ideas in such a way that they are fundable and scalable).
  • If so, please let others know about ocPortal whenever you see the opportunity.
  • If my reply is too Vulcan or expressed too much in business-strategy terms, and not particularly personal, I apologise. As a company & project maintainer, time is very limited to me, so usually when I write a reply I try and make it generic advice to all readers. I'm also naturally a joined-up thinker, so I always express my thoughts in combined business and technical terms. I recognise not everyone likes that, don't let my Vulcan-thinking stop you enjoying ocPortal on fun personal projects.
  • If my response can inspire a community tutorial, that's a great way of giving back to the project as a user.
Back to the top
 
Posted
Rating:
#40870
Avatar

Community saint

That will work for me, any thing to make the system better is all good. I will keep finding things for this though, just scared of breaking the rule about bring things up to much.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40874
Avatar

Bring up as much as you like, the feedback is much appreciated, thank you :). The rule is just to not keep posting the same bit of feedback.


Become a fan of ocPortal on Facebook or add me as a friend. Add me on on Twitter.
Was I helpful?
  • If not, please let us know how we can do better (please try and propose any bigger ideas in such a way that they are fundable and scalable).
  • If so, please let others know about ocPortal whenever you see the opportunity.
  • If my reply is too Vulcan or expressed too much in business-strategy terms, and not particularly personal, I apologise. As a company & project maintainer, time is very limited to me, so usually when I write a reply I try and make it generic advice to all readers. I'm also naturally a joined-up thinker, so I always express my thoughts in combined business and technical terms. I recognise not everyone likes that, don't let my Vulcan-thinking stop you enjoying ocPortal on fun personal projects.
  • If my response can inspire a community tutorial, that's a great way of giving back to the project as a user.
Back to the top
 
Posted
Rating:
#40876
Avatar

Community saint

Ok thanks if I do it its not intentional
I do have a thread about the staff page but it was asking where it was so not feedback so that makes me feel better. Oh and I did reply saying I found it.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40877
Avatar

Community saint

Another  faq question is.

Why does the quick installer not auto proceed?
My best guess is to save cpu processes as I have noticed a few times the quick installer does use more resources then the manual installer, still saves you time though as you do not have to do the chmoding.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40885
Avatar

Community saint

Another FAQ thing to add

Why does the download of the week not allow you to pick a download already on file in the download manager?
Simple answer is its like the image of the day and you just set up a new entry but are allowed to use the same file you have in the download manager.

Why does the image of the day not allow you to pick an image thats already in the gallery?
Simple answer is its like the download of the week and you just up load a new file but are allowed to use an image from the gallery.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40894
Avatar

Community saint

Here are some more.

Why is there not a option for cheat public chat in the chat room's main page?
The system comes with one pre made.
Answer gotten from that is ya but I want to make different chat rooms for different types of chat content.

Why does the shoutbox and the chat room use the same public chat room?
Its kind of like deans shoutbox for IPB the chat room and the shout box are connected.

How do your report some one in the shoutbox/chat if they not being good?
If no staff are around just PT or PM a staff and they will take care of it as soon as they can, you may also tell them to stop.

Why are the blogs and news the same thing? is it really a blog or just a news area?
Not sure I do not use the blog for ocportal.

In the gallery why does the image go from light to dark?
Its to show which one your mouse is over. The on your mouse is over will show up darker.


Whats the easies way to set up a comment box to go to any forum?
Hmm would have to find that post from CHris about the dos type thingy in the admin zone.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
There are too many online users to list.