[opensuse-doc] Re: [opensuse-project] openSUSE documentation
On 07/10/2019 06:43, Mike McCallister wrote:
Ish,
Back in March, Lana Brindley offered to work on revising/updating the openSUSE docs (https://lists.opensuse.org/opensuse-project/2019-03/msg00033.html). I also offered to help at that time. She ran into some issues opening communication with the SUSE Docs Team. I don't know where that initiative stands right now, but it's good to know there are others who want to help with openSUSE docs.
Yes, I'm still here, and still interested in getting a group together to work on openSUSE docs. As Frank pointed out, the best place to do that is the doc-sle repo: https://github.com/SUSE/doc-sle While I think it would be ideal to have the opensuse docs in their own repo, it's not technically feasible at this stage. I would definitely advocate for contributing to the docs in the repo rather than the wiki, though, just to avoid silos. The whole point of open source is to give back, and we can't do that if we're contributing in our own sandbox. Happy to help anyone who might like some pointers on using github or docbook. Also, the docs mailing list has been reactivated, so feel free to chat further there (it's in cc). Lana
Another thread on this is on the opensuse-web list. I can't find that link, but it's around the same time.
Mike McCallister
On 10/6/2019 5:47 AM, Ish Sookun wrote:
Folks,
During the openSUSE Asia Summit's community meeting we discussed things that should be & can be done. One of those was about the openSUSE documentation.
I checked doc.opensuse.org.
I notice that all the documentation are currently copyrighted [1] by SUSE. Although the docs are granted GNU Free Documentation License it sounds proper to have the content ownership under openSUSE. Such a thing should not wait for the creation of a foundation.
It also appears that the documentation workload is currently on the shoulders of the SUSE documentation team (only). I would like to help, more specifically collaborating with Kubic/MicroOS team to have a Container documentation. How should I proceed?
Regards,
Ish Sookun
[1] https://doc.opensuse.org/documentation/leap/virtualization/book.virt_color_e...
-- Lana Brindley @Loquacities Technical Writer - SUSE Manager "The question is," said Alice, "whether you can make words mean so many different things." -- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-doc+owner@opensuse.org
Hi Lana, On 10/8/19 10:13 AM, Lana Brindley wrote:
I would definitely advocate for contributing to the docs in the repo rather than the wiki, though, just to avoid silos. The whole point of open source is to give back, and we can't do that if we're contributing in our own sandbox.
Happy to help anyone who might like some pointers on using github or docbook.
Also, the docs mailing list has been reactivated, so feel free to chat further there (it's in cc).
I forked the repo and was able to build PDFs using daps. So, I believe I have the environment to start working on the doc. Now, the next question is that some folks from openSUSE Asia and I wanted to work on containers documentation. Currently, there is only a few paragraphs about containers in the openSUSE Virtualization doc. We think it might be more helpful to have a separate openSUSE Containers doc that covers MicroOS, Kubic and the various tools such as kubeadm, podman, buildah etc. What would you advise? Regards, Ish Sookun -- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-doc+owner@opensuse.org
On 10/10/2019 07:45, Ish Sookun wrote:
Hi Lana,
On 10/8/19 10:13 AM, Lana Brindley wrote:
I would definitely advocate for contributing to the docs in the repo rather than the wiki, though, just to avoid silos. The whole point of open source is to give back, and we can't do that if we're contributing in our own sandbox.
Happy to help anyone who might like some pointers on using github or docbook.
Also, the docs mailing list has been reactivated, so feel free to chat further there (it's in cc).
I forked the repo and was able to build PDFs using daps. So, I believe I have the environment to start working on the doc.
Great!
Now, the next question is that some folks from openSUSE Asia and I wanted to work on containers documentation. Currently, there is only a few paragraphs about containers in the openSUSE Virtualization doc.
We think it might be more helpful to have a separate openSUSE Containers doc that covers MicroOS, Kubic and the various tools such as kubeadm, podman, buildah etc.
What would you advise?
Sounds like a new doc would be warranted, that's a lot of content. Unless you want to start by adding a chapter to the Virt doc, and then we can split it out on its own later on? Lana -- Lana Brindley @Loquacities Technical Writer - SUSE Manager "The question is," said Alice, "whether you can make words mean so many different things." -- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-doc+owner@opensuse.org
Hi all, Le jeudi 10 octobre 2019 à 09:45 +1000, Lana Brindley a écrit :
On 10/10/2019 07:45, Ish Sookun wrote:
Hi Lana,
On 10/8/19 10:13 AM, Lana Brindley wrote:
I would definitely advocate for contributing to the docs in the repo rather than the wiki, though, just to avoid silos. The whole point of open source is to give back, and we can't do that if we're contributing in our own sandbox.
Happy to help anyone who might like some pointers on using github or docbook.
Also, the docs mailing list has been reactivated, so feel free to chat further there (it's in cc).
I forked the repo and was able to build PDFs using daps. So, I believe I have the environment to start working on the doc.
I join this thread that I read with interest since I wanted to translate the reference doc in French a few months ago. I sent an email [0] about my intention to do so, asking permission as the doc is copyrighted. I had no answers, nor from the openSUSE side, neither from the SUSE doc team side. Does anyone know if it is OK to start working on it ? Thanks ! [0] https://lists.opensuse.org/opensuse-doc/2019-06/msg00000.html -- 'When there is no more room at school, the dumb will walk the Earth.' Sébastien 'sogal' Poher -- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-doc+owner@opensuse.org
Hi Sébastien, I'm sorry you didn't get a response to your initial mail. I don't represent the documentation team (I'm part of the SUSE Manager team instead), but I can't see anything preventing you from doing this. Go right ahead and start work, and I'm sure someone will yell if they have an issue. Sometimes it's better to ask forgiveness than permission, anyway ;) Lana On 11/10/2019 00:46, Sébastien 'sogal' Poher wrote:
Hi all,
On 10/10/2019 07:45, Ish Sookun wrote:
Hi Lana,
On 10/8/19 10:13 AM, Lana Brindley wrote:
I would definitely advocate for contributing to the docs in the repo rather than the wiki, though, just to avoid silos. The whole point of open source is to give back, and we can't do that if we're contributing in our own sandbox.
Happy to help anyone who might like some pointers on using github or docbook.
Also, the docs mailing list has been reactivated, so feel free to chat further there (it's in cc).
I forked the repo and was able to build PDFs using daps. So, I believe I have the environment to start working on the doc. I join this thread that I read with interest since I wanted to
Le jeudi 10 octobre 2019 à 09:45 +1000, Lana Brindley a écrit : translate the reference doc in French a few months ago. I sent an email [0] about my intention to do so, asking permission as the doc is copyrighted. I had no answers, nor from the openSUSE side, neither from the SUSE doc team side.
Does anyone know if it is OK to start working on it ?
Thanks !
[0] https://lists.opensuse.org/opensuse-doc/2019-06/msg00000.html
-- Lana Brindley @Loquacities Technical Writer - SUSE Manager "The question is," said Alice, "whether you can make words mean so many different things." -- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-doc+owner@opensuse.org
Hi Lana, Le vendredi 11 octobre 2019 à 09:18:36, Lana Brindley a écrit :
Hi Sébastien,
I'm sorry you didn't get a response to your initial mail. I don't represent the documentation team (I'm part of the SUSE Manager team instead), but I can't see anything preventing you from doing this. Go right ahead and start work, and I'm sure someone will yell if they have an issue.
Thanks for your anwser, I will continue working on it and push my first commits to see if someone screams.
Sometimes it's better to ask forgiveness than permission, anyway ;)
I coudl not agree more ! :) Cheers
On 11/10/2019 00:46, Sébastien 'sogal' Poher wrote:
Hi all,
On 10/10/2019 07:45, Ish Sookun wrote:
Hi Lana,
On 10/8/19 10:13 AM, Lana Brindley wrote:
I would definitely advocate for contributing to the docs in the repo rather than the wiki, though, just to avoid silos. The whole point of open source is to give back, and we can't do that if we're contributing in our own sandbox.
Happy to help anyone who might like some pointers on using github or docbook.
Also, the docs mailing list has been reactivated, so feel free to chat further there (it's in cc).
I forked the repo and was able to build PDFs using daps. So, I believe I have the environment to start working on the doc. I join this thread that I read with interest since I wanted to
Le jeudi 10 octobre 2019 à 09:45 +1000, Lana Brindley a écrit : translate the reference doc in French a few months ago. I sent an email [0] about my intention to do so, asking permission as the doc is copyrighted. I had no answers, nor from the openSUSE side, neither from the SUSE doc team side.
Does anyone know if it is OK to start working on it ?
Thanks !
[0] https://lists.opensuse.org/opensuse-doc/2019-06/msg00000.html
-- Lana Brindley @Loquacities Technical Writer - SUSE Manager
"The question is," said Alice, "whether you can make words mean so many different things."
-- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-doc+owner@opensuse.org
-- 'When there is no more room at school, the dumb will walk the Earth.' Sébastien 'sogal' Poher -- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-doc+owner@opensuse.org
Hi Lana, On 10/10/19 7:45 AM, Lana Brindley wrote:
Sounds like a new doc would be warranted, that's a lot of content. Unless you want to start by adding a chapter to the Virt doc, and then we can split it out on its own later on?
The current virtualization doc is for Leap 15.1 and there is a one page introduction to Linux containers that only explains its benefits and limitations. Expanding that chapter to MicroOS/Kubic would be misleading under Leap 15.1. IMHO MicroOS/Kubic should be separate. However, the current chapter could be expanded to explain about container runtimes that are available for Leap 15.1. I'll be working on that for the next few days. Regards, Ish Sookun -- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-doc+owner@opensuse.org
participants (3)
-
Ish Sookun -
Lana Brindley -
Sébastien 'sogal' Poher