[opensuse-doc] Online Manual input source
As a subscriber to the opensuse-users list for a few years and seeing the queries that are answeered there, may I suggest that the mailing list posts become a part of the online manual as it is here, in opensuse-users that many problems are solved. I have often thought of using the opensuse list as a source to write my own SUSE manual but have problems getting started, especially i.t.o. f the structure/contents. I am unsure how to do it across distro versions but if someone at OpenSUSE could have final say on wheher a wiki entry is published or not, I am almost sure that this would be an excelent example of opensource sharing. What are you folk' thoughts on this? --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
On Sunday 06 May 2007 13:58, Hylton Conacher (ZR1HPC) wrote:
As a subscriber to the opensuse-users list for a few years and seeing the queries that are answeered there, may I suggest that the mailing list posts become a part of the online manual as it is here, in opensuse-users that many problems are solved.
I have often thought of using the opensuse list as a source to write my own SUSE manual but have problems getting started, especially i.t.o. f the structure/contents.
I am unsure how to do it across distro versions but if someone at OpenSUSE could have final say on wheher a wiki entry is published or not, I am almost sure that this would be an excelent example of opensource sharing.
What are you folk' thoughts on this?
Good idea. The structure - layout that is by now quite well established and can be reused for other projects is for instance: http://en.opensuse.org/HOWTOs The other that I have not much experience might be SDB that has included version information. -- Regards, Rajko. --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
On Sunday 06 May 2007 20:58, Hylton Conacher (ZR1HPC) wrote:
As a subscriber to the opensuse-users list for a few years and seeing the queries that are answeered there, may I suggest that the mailing list posts become a part of the online manual as it is here, in opensuse-users that many problems are solved.
I have often thought of using the opensuse list as a source to write my own SUSE manual but have problems getting started, especially i.t.o. f the structure/contents.
I am unsure how to do it across distro versions but if someone at OpenSUSE could have final say on wheher a wiki entry is published or not, I am almost sure that this would be an excelent example of opensource sharing.
What are you folk' thoughts on this?
Have you looked into the Lessons for Lizards project? It might be an excellent way to get the information you consider important into an easily-accessible format. The plan is to provide LfL on an equal footing to our internally-produced manuals, so it definitely would be somewhere even newbies could find it. The in-house documentation team is willing to help you get started contributing articles and help with conversion to docbook if needed. Unfortunately there isn't an effective wiki->docbook conversion tool at this time. Sincerely, Rebecca --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
On Sunday 06 May 2007 20:58, Hylton Conacher (ZR1HPC) wrote:
As a subscriber to the opensuse-users list for a few years and seeing the queries that are answeered there, may I suggest that the mailing list posts become a part of the online manual as it is here, in opensuse-users that many problems are solved.
I have often thought of using the opensuse list as a source to write my own SUSE manual but have problems getting started, especially i.t.o. f the structure/contents.
I am unsure how to do it across distro versions but if someone at OpenSUSE could have final say on wheher a wiki entry is published or not, I am almost sure that this would be an excelent example of opensource sharing.
What are you folk' thoughts on this?
Have you looked into the Lessons for Lizards project? It might be an excellent way to get the information you consider important into an easily-accessible format..... I have, and find that it is not categorised and as structured as I would have expected and the menu is faar too long as I am almost sure many of
Rebecca Walter wrote: the subheadings could be grouped under a single parent heading.
.... The plan is to provide LfL on an equal footing to our internally-produced manuals, so it definitely would be somewhere even newbies could find it. With this in mind ie that newies and Windows users will be reading LFL, it needs to be far more structured so that it is easy to navigate an item a newbie is searching for assistance on.
The in-house documentation team is willing to help you get started contributing articles and help with conversion to docbook if needed. I would be interested in joining the DUSE Documentation Team and lending a hand, learning lots but producing a better customer experience. I cannot say I know Linux, but I know more about Linux than the average Windows user and I have a willingness to learn. I'm thinking of perhaps writing a few pages on tips that I would be interested in ie I'd establish the tip but ask that I can then pose questions on the opensuse list and also to the documentation team to obtain the information I need to complete the tip.
Unfortunately there isn't an effective wiki->docbook conversion tool at this time. That's fine, but then there needs to be a method to distribute all the varied subjects that come in via email to the opensuse list to a LFL writer. I propose someone who reads all the opensuse mail and forwards
I notice that Openoffice.org 2.04 can save in Docbook format and I wonder if the template is available in .odt format? I'd have a later version of OOo but I haven't been able to get Yast to find a newer source. the email to a ariety of LFL topic writers ie if I was the email distributor and if you only dealt with the system updates section in the LFL book then you would only receive email from me if something was discussed on the opensuse list about updates. Emails about networking would go to the LFL networking writer, but he would not know or receive anything from me about updates as that is not the topic he/she are concentrating on. --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
Hi Hylton, welcome to opensuse-doc! :-) On Dienstag, 8. Mai 2007, Hylton Conacher (ZR1HPC) wrote:
Have you looked into the Lessons for Lizards project? It might be an excellent way to get the information you consider important into an easily-accessible format.....
I have, and find that it is not categorised and as structured as I would have expected and the menu is faar too long as I am almost sure many of the subheadings could be grouped under a single parent heading.
We have started it only a few months ago so it takes time everybody get used to it. It might look a bit unbalanced.
.... The plan is to provide LfL on an equal footing to our internally-produced manuals, so it definitely would be somewhere even newbies could find it.
With this in mind ie that newies and Windows users will be reading LFL, it needs to be far more structured so that it is easy to navigate an item a newbie is searching for assistance on.
Do you have something special in mind? I am very interested in listing to your suggestions. Could you elaborate your ideas a bit more? Is it the structure itself or the content of some articles, or anything else?
The in-house documentation team is willing to help you get started contributing articles and help with conversion to docbook if needed.
I would be interested in joining the DUSE Documentation Team and lending a hand, learning lots but producing a better customer experience. I cannot say I know Linux, but I know more about Linux than the average Windows user and I have a willingness to learn. I'm thinking of perhaps writing a few pages on tips that I would be interested in ie I'd establish the tip but ask that I can then pose questions on the opensuse list and also to the documentation team to obtain the information I need to complete the tip.
That's a fair deal. :-) There are lots of task to improve LfL, you do not have to be necessarily a writer. For more details look here: http://developer.novell.com/wiki/index.php/Lfl/Tasks
I notice that Openoffice.org 2.04 can save in Docbook format and I wonder if the template is available in .odt format? I'd have a later version of OOo but I haven't been able to get Yast to find a newer source.
We didn't create a template in OpenOffice.org. When I tried it last time it created a pretty flat structure. Unfortunatly it takes some time and XML experience to adapt it to the LfL structure depending it how your original document looks like. I don't think this makes sense. However, if you would like to write something, I would suggest to have a look at the LfL template, at https://forgesvn1.novell.com/viewsvn/lfl/trunk/common/xml/ It's a DocBook-XML file and the preferred format. The file contains the basic structure for writing any articles, so you can use it as a start. If you feel uncomfortable with this format you can also write in plain text and ask for any volunteer to convert it. Please read also the "Quick Start for Writers": http://developer.novell.com/wiki/index.php/Lfl/Quick_Start_for_Writers And of course, if you have any special questions don't hesitate to ask on this mailinglist. :-)
[...]
Thanks for asking! :-) Bye, Tom -- ---------------------------------------------------------------------- SUSE LINUX Products GmbH >o) Maxfeldstrasse 5 /\\ Documentation Specialist 90409 Nuernberg, Germany _\_v http://en.opensuse.org/Documentation_Team SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG Nürnberg) --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
Thomas Schraitle wrote:
Hi Hylton,
welcome to opensuse-doc! :-) Tnx Thomas,
Sorry for the delay in replying.
On Dienstag, 8. Mai 2007, Hylton Conacher (ZR1HPC) wrote:
Have you looked into the Lessons for Lizards project? It might be an excellent way to get the information you consider important into an easily-accessible format..... I have, and find that it is not categorised and as structured as I would have expected and the menu is faar too long as I am almost sure many of the subheadings could be grouped under a single parent heading.
We have started it only a few months ago so it takes time everybody get used to it. It might look a bit unbalanced. OK, although I think with a better structure of what topics ned writing on would be better as then writers can choose and be allocated to a writing/contributing to a task.
.... The plan is to provide LfL on an equal footing to our internally-produced manuals, so it definitely would be somewhere even newbies could find it. With this in mind ie that newies and Windows users will be reading LFL, it needs to be far more structured so that it is easy to navigate an item a newbie is searching for assistance on.
Do you have something special in mind? I am very interested in listing to your suggestions. Could you elaborate your ideas a bit more? Is it the structure itself or the content of some articles, or anything else? Thank you for taking the time to listen. As I said earlier, I think it is the structure itself. The online book/manual is going to be an ever changing and growing, so readers need to know where to look for help on the problem they are experiencing, as opposed to having to basically scour the whole manual.
The in-house documentation team is willing to help you get started contributing articles and help with conversion to docbook if needed. I would be interested in joining the DUSE Documentation Team and lending a hand, learning lots but producing a better customer experience. I cannot say I know Linux, but I know more about Linux than the average Windows user and I have a willingness to learn. I'm thinking of perhaps writing a few pages on tips that I would be interested in ie I'd establish the tip but ask that I can then pose questions on the opensuse list and also to the documentation team to obtain the information I need to complete the tip.
That's a fair deal. :-) There are lots of task to improve LfL, you do not have to be necessarily a writer. For more details look here:
http://developer.novell.com/wiki/index.php/Lfl/Tasks I had a look and seem to fit in as a designer but more for the layout/structure of the LFL book.
I notice that Openoffice.org 2.04 can save in Docbook format and I wonder if the template is available in .odt format? I'd have a later version of OOo but I haven't been able to get Yast to find a newer source.
We didn't create a template in OpenOffice.org. When I tried it last time it created a pretty flat structure. Unfortunatly it takes some time and XML experience to adapt it to the LfL structure depending it how your original document looks like. I don't think this makes sense.
However, if you would like to write something, I would suggest to have a look at the LfL template, at
https://forgesvn1.novell.com/viewsvn/lfl/trunk/common/xml/
It's a DocBook-XML file and the preferred format. The file contains the basic structure for writing any articles, so you can use it as a start. If you feel uncomfortable with this format you can also write in plain text and ask for any volunteer to convert it. Please read also the "Quick Start for Writers":
http://developer.novell.com/wiki/index.php/Lfl/Quick_Start_for_Writers
And of course, if you have any special questions don't hesitate to ask on this mailinglist. :-) Well I think i would be more use in helping design the base structure or Contents that the various writers are going to write articles for. With the structure in place it can also give the writer a little guidance on how technical or newbie they have to write.
[...]
Thanks for asking! :-) Sorry, What did I ask ? :)
Ciao --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
Hi Hylton, On Dienstag, 15. Mai 2007, Hylton Conacher (ZR1HPC) wrote:
Sorry for the delay in replying.
Not a problem. :)
On Dienstag, 8. Mai 2007, Hylton Conacher (ZR1HPC) wrote:
Have you looked into the Lessons for Lizards project? It might be an excellent way to get the information you consider important into an easily-accessible format.....
I have, and find that it is not categorised and as structured as I would have expected and the menu is faar too long as I am almost sure many of the subheadings could be grouped under a single parent heading.
We have started it only a few months ago so it takes time everybody get used to it. It might look a bit unbalanced.
OK, although I think with a better structure of what topics ned writing on would be better as then writers can choose and be allocated to a writing/contributing to a task.
We have a template that each topic should use, see here: https://forgesvn1.novell.com/svn/lfl/trunk/common/xml/topic-template.xml The idea was to create chapters that deal with certain topics like Installation, Networking, System Administration, etc. If someone writes a topic it is easier to include it under an available category. I think the structure of the above template should be sufficient for many topics. Do you think there is anything missing?
Do you have something special in mind? I am very interested in listing to your suggestions. Could you elaborate your ideas a bit more? Is it the structure itself or the content of some articles, or anything else?
Thank you for taking the time to listen. As I said earlier, I think it is the structure itself. The online book/manual is going to be an ever changing and growing, so readers need to know where to look for help on the problem they are experiencing, as opposed to having to basically scour the whole manual.
Ok. Do you have an example that illustrates your problem? I am not sure if I understand your issue completely.
[...] For more details look here:
I had a look and seem to fit in as a designer but more for the layout/structure of the LFL book.
If you want to improve the stylesheets or need a place for your ideas I can give you access to the Subversion repository. Send me a private mail with your login name.
[...]
Well I think i would be more use in helping design the base structure or Contents that the various writers are going to write articles for. With the structure in place it can also give the writer a little guidance on how technical or newbie they have to write.
Everybody can participate in this project. In the end there should be consensus of what you propose. You can write a "Request for Improvements" and discuss it with others here on this mailinglist. :)
[...]
Thanks for asking! :-)
Sorry, What did I ask ? :)
Well, that was a over-simplification on my side. :-) Bye, Tom -- Thomas Schraitle ---------------------------------------------------------------------- SUSE LINUX GmbH >o) Documentation Specialist Maxfeldstrasse 5 /\\ 90409 Nuernberg _\_v http://en.opensuse.org/Documentation_Team --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
participants (4)
-
Hylton Conacher (ZR1HPC) -
Rajko M. -
Rebecca Walter -
Thomas Schraitle