openSUSE Documentation October 2019

doc@lists.opensuse.org

4 participants
5 discussions

[opensuse-doc] Re: [opensuse-project] doc.opensuse.org
by Lana Brindley 15 Oct '19

15 Oct '19

(Adding the opensuse docs ML to cc) On 15/10/2019 22:46, Jason Evans wrote: >> if we're building up on the existing documentation contributed by >> SUSE >> folks. > Actually I'm talking about creating new documents and not just putting > in pull requests for the existing docs. For example, besides the quick > start guide that I wrote last spring there isn't much for Kubic. I > think we need a new document build from scratch on how to use it. The repo is open, so if you think a new document is required, then go right ahead. >> I've been looking at Docbook the past few days in order to contribute >> somehow on Container documentation. I think Docbook's fine, >> especially >> >> >> Having part of the documentation written in Docbook and another part >> in >> AsciiDoc leads to the same as having doc.o.o vs wiki.o.o. > Actually the SUSE docs team does that now. Daps natively handles both. > Some people only write in Docbook and some only write in asciidoc. You > can't tell the difference because Daps produces the same output for > both. That is true. If you're editing existing docbook content, then use docbook. Of course, if you want to create a new document, feel free to use asciidoc. The use of asciidoc is still fairly new within the team, so there are fewer guidelines, etc, written down, but that is improving. I have used both languages extensively, so I'm always here to help if you have questions on syntax or usage. > > I think the goal would be to encourage community participation. Docbook > creates an artificial roadblock to that because of it's significantly > higher learning curve. We should want people spending their valuable > time submitting pull requests to help build something not spending > hours trying to find out why their xml isn't working. I agree with you on this. I've worked on a few community docs teams that switched from heavier languages like docbook to markup languages, and there's always a corresponding increase in outside contributions after the change. Thanks for your interest :) 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(a)opensuse.org To contact the owner, e-mail: opensuse-doc+owner(a)opensuse.org

1 0

[opensuse-doc] Re: [opensuse-project] openSUSE documentation
by Lana Brindley 11 Oct '19

11 Oct '19

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_… -- 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(a)opensuse.org To contact the owner, e-mail: opensuse-doc+owner(a)opensuse.org

3 6

[opensuse-doc] Greetings
by Robin Shepheard 09 Oct '19

09 Oct '19

Hi everyone Just a wish intro. I am looking at helping with documentation for the project if I can. I have been using Linux since the late 90's and used many different flavours for various purposes over the years. I haven't had much chance to contribute during that time but due to my work commitments I shall have more time to do so. I will just be a lurker for a little while as I will need to familiarise myself with docbook and github but hope to be able to help contributing soon. As this is my first venture in a project like this any pointers would be very gratefully received although I am happy to figure stuff out by myself where I can. Oh and if it makes any difference to anyone, I live in the south or the UK and work 4 on 4 off nightshifts so will be around at all sorts of random times Cheers Robin Sent with ProtonMail Secure Email.

2 3

[opensuse-doc] Re: [opensuse-project] openSUSE documentation
by Ish Sookun 07 Oct '19

07 Oct '19

Hi Henne, On 10/7/19 6:36 PM, Henne Vogelsang wrote: > There is no such thing as openSUSE, we don't have a legal entity you can > assign copyright to. :-) The footer of wiki.o.o contains: © 2001–2019 SUSE LLC, © 2005–2019 openSUSE Contributors & others. Can't we mention the same for doc.o.o? Regards, Ish Sookun -- To unsubscribe, e-mail: opensuse-doc+unsubscribe(a)opensuse.org To contact the owner, e-mail: opensuse-doc+owner(a)opensuse.org

1 0

[opensuse-doc] openSUSE documentation
by Ish Sookun 06 Oct '19

06 Oct '19

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_… -- To unsubscribe, e-mail: opensuse-doc+unsubscribe(a)opensuse.org To contact the owner, e-mail: opensuse-doc+owner(a)opensuse.org

1 0

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

openSUSE Documentation October 2019