<div dir="ltr">Hi Stef,<font face="yw-2503fced21430554d14592103c146e0c7e052700-37076bc5d323b0a9358972873b0520d9--" style></font><div><br></div><div>Regarding the versioning and linking questions to the paragraphs,</div><div>
I think there will be a limitation that once the paragraph changes,</div><div>any questions will be detached. </div><div><br></div><div>We could track content of paragraphs</div><div>by remembering hash values of their content.</div>
<div><br></div><div>We could still display those questions and maybe give an option</div><div>to re-attach them to the corresponding paragraphs.</div><div><br></div><div>Best regards,</div><div>Evgeny.</div><div><br></div>
<div><br></div></div><div class="gmail_extra"><br><br><div class="gmail_quote">On Thu, Oct 31, 2013 at 8:02 PM, Stefano Maffulli <span dir="ltr"><<a href="mailto:stefano@openstack.org" target="_blank">stefano@openstack.org</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">On 10/30/2013 05:56 PM, Stefano Maffulli wrote:<br>
>> Another use case could be - via inserting markers into the text of<br>
>> the doc page where the questions are or around the paragraphs. When<br>
>> you click on the marker - a corresponding question opens in the<br>
>> sidebar. I.e. - questions can be tied to specific paragraphs, where<br>
>> possible.<br>
<br>
</div>I think this is the most interesting bits of all. What I think would be<br>
very useful is to have a place *on the documentation page* for people to<br>
express doubts and ask questions. So, a use case would be of a user that<br>
goes to <a href="http://docs.openstack.org/user-guide/content/cli_openrc.html" target="_blank">http://docs.openstack.org/user-guide/content/cli_openrc.html</a> and<br>
has a doubt about it. The user notices a place at the bottom where she<br>
can ask a new question with her doubts. The new question would be<br>
connected to the related page only, visible only on<br>
<a href="http://docs.openstack.org/user-guide/content/cli_openrc.html" target="_blank">http://docs.openstack.org/user-guide/content/cli_openrc.html</a> and on<br>
<a href="https://ask.openstack.org" target="_blank">https://ask.openstack.org</a> of course. If there are other questions<br>
connected to that page, all of them would have to be shown (collapsed?)<br>
before the 'ask a new question'.<br>
<br>
What's not clear to me is how to manage versioning of documentation.<br>
Let's assume that a question is related to<br>
<a href="http://docs.openstack.org/user-guide/content/cli_openrc.html" target="_blank">http://docs.openstack.org/user-guide/content/cli_openrc.html</a> and that<br>
page gets fixed/updated making (some, if not all) questions obsolete/not<br>
relevant: how to manage the obsolescence? And more deeply, how to manage<br>
the link between individual pages and questions?<br>
<div class="im"><br>
>> If a paragraph does not have questions - hovering over the text of<br>
>> the doc page will display a prompt to "ask a question" about the<br>
>> paragraph over which the pointer is hovering.<br>
<br>
</div>I would love to work at the paragraph level with questions (like Google<br>
Docs comments) but I'm not sure how we can achieve that by keeping the<br>
current docs authoring and build workflow. Any ideas?<br>
<div class="im"><br>
>> It could be useful to link authors of the page with the profiles in<br>
>> the Q&A system, if they exist, in order to notify the authors of the<br>
>> new questions.<br>
<br>
</div>Can the people interested in answering questions about documentation<br>
would get a notification of a new question or updates to old questions<br>
(comments or answers) using the standard notification system of Askbot<br>
(subscribing to a tag or something similar)?<br>
<div class="im"><br>
>> On the "regular" forum question pages there would be "backlinks" to<br>
>> the relevant doc pages.<br>
>><br>
>> Questions may be assigned/reassigned to one or more doc pages.<br>
<br>
</div>This would be cool, too, a way to manually curate/enrich the question<br>
like we do with bugs. Which brings us back to the question above: how to<br>
link a question/answer and the originating page with its version?<br>
<div class="HOEnZb"><div class="h5"><br>
/stef<br>
<br>
--<br>
Ask and answer questions on <a href="https://ask.openstack.org" target="_blank">https://ask.openstack.org</a><br>
</div></div></blockquote></div><br><br clear="all"><div><br></div>-- <br><div dir="ltr">Askbot<div>Valparaiso, Chile</div><div>skype: evgeny-fadeev</div></div>
</div>