What is this?
The \OpenQuestion category is a unique feature of Wiki-style documentation. How many times have you been reading a manual, looking for something specific, and closed it in frustration, thinking to yourself “why doesn’t it just explain X!?”
Days later, you return to the manual and look again, but the explanation you are seeking still isn’t there…unless of course, it’s Wiki documentation.
A real life story
For instance, someone reading this site a while back wanted to know HowToRunBackgroundJobsInRails. They didn’t find what they wanted, so they created a new topic, and in it they wrote:
I’m sure this is a newbie question, but then I am a newbie on Ruby :).
How do I run background jobs in Ruby? All the doc I’ve found so far is for response based code e.g. user pushed button, Ruby bootstraps itself → runs some code → sends back a page.
How can I just plain, run some code and, for example, change the escalation level on a “bug” record from “normal” to “too old” if a record ages too much?
Alternately can I write a background job that’ll, for example, spit out a nicely formatted text file every night at 2:00 AM?
Other people came along, saw what they had written, added to it, moved things around, and from that seed of a question, an answer began to grow.
You can too!
If you are looking for something and can’t find it, go to where you think it ought to be and add an “\OpenQuestion” by either
- Editing an existing topic and inserting your question at an appropriate point or
- Creating a new topic for your question
In either case, if you mark it with “\OpenQuestion” (O & Q capitalized, no space between them) it will automatically be listed in the “linked from” list at the bottom of this page to help helpful people find (and maybe even answer).
category: Glossary
What is this?
The \OpenQuestion category is a unique feature of Wiki-style documentation. How many times have you been reading a manual, looking for something specific, and closed it in frustration, thinking to yourself “why doesn’t it just explain X!?”
Days later, you return to the manual and look again, but the explanation you are seeking still isn’t there…unless of course, it’s Wiki documentation.
A real life story
For instance, someone reading this site a while back wanted to know HowToRunBackgroundJobsInRails. They didn’t find what they wanted, so they created a new topic, and in it they wrote:
I’m sure this is a newbie question, but then I am a newbie on Ruby :).
How do I run background jobs in Ruby? All the doc I’ve found so far is for response based code e.g. user pushed button, Ruby bootstraps itself → runs some code → sends back a page.
How can I just plain, run some code and, for example, change the escalation level on a “bug” record from “normal” to “too old” if a record ages too much?
Alternately can I write a background job that’ll, for example, spit out a nicely formatted text file every night at 2:00 AM?
Other people came along, saw what they had written, added to it, moved things around, and from that seed of a question, an answer began to grow.
You can too!
If you are looking for something and can’t find it, go to where you think it ought to be and add an “\OpenQuestion” by either
- Editing an existing topic and inserting your question at an appropriate point or
- Creating a new topic for your question
In either case, if you mark it with “\OpenQuestion” (O & Q capitalized, no space between them) it will automatically be listed in the “linked from” list at the bottom of this page to help helpful people find (and maybe even answer).
category: Glossary